Azure Data Factory

This module creates an Azure Data Factory with diagnostic settings enabled.

Global versioning rule for Claranet Azure modules

Module version	Terraform version	OpenTofu version	AzureRM version
>= 8.x.x	Unverified	1.8.x	>= 4.0
>= 7.x.x	1.3.x		>= 3.0
>= 6.x.x	1.x		>= 3.0
>= 5.x.x	0.15.x		>= 2.0
>= 4.x.x	0.13.x / 0.14.x		>= 2.0
>= 3.x.x	0.12.x		>= 2.0
>= 2.x.x	0.12.x		< 2.0
< 2.x.x	0.11.x		< 2.0

Contributing

If you want to contribute to this repository, feel free to use our pre-commit git hook configuration which will help you automatically update and format some files for you by enforcing our Terraform code module best-practices.

More details are available in the CONTRIBUTING.md file.

Usage

This module is optimized to work with the Claranet terraform-wrapper tool which set some terraform variables in the environment needed by this module. More details about variables set by the terraform-wrapper available in the documentation.

⚠️ Since modules version v8.0.0, we do not maintain/check anymore the compatibility with Hashicorp Terraform. Instead, we recommend to use OpenTofu.

module "data_factory" {
  source  = "claranet/data-factory/azurerm"
  version = "x.x.x"

  client_name    = var.client_name
  environment    = var.environment
  location       = module.azure_region.location
  location_short = module.azure_region.location_short
  stack          = var.stack

  resource_group_name = module.rg.name

  integration_runtime_type = "SelfHosted"

  logs_destinations_ids = [module.logs.id]
}

Providers

Name	Version
azurecaf	~> 1.2.28
azurerm	~> 4.9

Modules

Name	Source	Version
diagnostics	claranet/diagnostic-settings/azurerm	~> 8.1.0

Resources

Name	Type
azurecaf_name.data_factory_name	resource
azurerm_data_factory.main	resource
azurerm_data_factory_integration_runtime_azure.integration_runtime	resource
azurerm_data_factory_integration_runtime_azure_ssis.integration_runtime	resource
azurerm_data_factory_integration_runtime_self_hosted.integration_runtime	resource

Inputs

Name	Description	Type	Default	Required
azure_devops_configuration	Azure DevOps configuration for data factory. For arguments, please refer to documentation.	map(string)	null	no
client_name	Client name/account used in naming.	string	n/a	yes
custom_name	Custom name of the Data Factory, generated if not set.	string	null	no
default_tags_enabled	Option to enable or disable default tags.	bool	true	no
diagnostic_settings_custom_name	Custom name of the diagnostics settings, name will be default if not set.	string	"default"	no
environment	Project environment.	string	n/a	yes
extra_tags	Additional tags to associate with your Data Factory.	map(string)	{}	no
github_configuration	Github configuration for data factory. For arguments, please refer to documentation.	map(string)	null	no
global_parameters	Global parameters for data factory. For arguments, please refer to documentation.	list(map(string))	[]	no
identity_ids	Specifies a list of User Assigned Managed Identity IDs to be assigned to this Data Factory.	list(string)	null	no
identity_type	Specifies the type of Managed Service Identity that should be configured on this Data Factory. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).	string	"SystemAssigned"	no
integration_runtime_configuration	Parameters used to configure AzureSSIS integration runtime: node_size (optional, defaults to Standard_D2_v3) number_of_nodes (optional, defaults to 1) max_parallel_executions_per_nodes (optional, defaults to 1) edition (optional, defaults to Standard) license_type (optional, defaults to LicenseIncluded) Parameters used to configure Azure integration runtime cleanup_enabled (optional, defaults to true) compute_type (optional, defaults to General) core_count (optional, defaults to 8) time_to_live_min (optional, defaults to 0) virtual_network_enabled (optional, defaults to false)	map(any)	{}	no
integration_runtime_custom_name	Name of the integration_runtime resource.	string	null	no
integration_runtime_description	Integration runtime description.	string	null	no
integration_runtime_type	Specifies the integration runtime type. Possible values are Azure, AzureSSIS and SelfHosted.	string	null	no
location	Azure region to use.	string	n/a	yes
location_short	Short string for Azure location.	string	n/a	yes
logs_categories	Log categories to send to destinations.	list(string)	null	no
logs_destinations_ids	List of destination resources IDs for logs diagnostic destination. Can be Storage Account, Log Analytics Workspace and Event Hub. No more than one of each can be set. If you want to use Azure EventHub as a destination, you must provide a formatted string containing both the EventHub Namespace authorization send ID and the EventHub name (name of the queue to use in the Namespace) separated by the | character.	list(string)	n/a	yes
logs_metrics_categories	Metrics categories to send to destinations.	list(string)	null	no
managed_virtual_network_enabled	True to enable managed virtual network.	bool	true	no
name_prefix	Optional prefix for the generated name.	string	""	no
name_suffix	Optional suffix for the generated name.	string	""	no
public_network_enabled	True to make data factory visible to the public network.	bool	false	no
resource_group_name	Name of the resource group.	string	n/a	yes
stack	Project stack name.	string	n/a	yes

Outputs

Name	Description
id	Data Factory id.
identity_principal_id	Data Factory system identity principal ID.
integration_runtime	Data Factory integration runtime resource object.
integration_runtime_id	Data Factory integration runtime id.
integration_runtime_type	Data Factory integration runtime type.
name	Data Factory name.
resource	Data Factory resource object.
self_hosted_integration_runtime_primary_authorization_key	The self hosted integration runtime primary authentication key.
self_hosted_integration_runtime_secondary_authorization_key	The self hosted integration runtime secondary authentication key.

Related documentation

Microsoft Azure documentation: docs.microsoft.com/en-us/azure/data-factory