Manages a Data Factory Azure-SSIS Integration Runtime.
resource "azurerm_resource_group" "example" {
name = "example-resources"
location = "West Europe"
}
resource "azurerm_data_factory" "example" {
name = "example"
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
}
resource "azurerm_data_factory_integration_runtime_azure_ssis" "example" {
name = "example"
data_factory_id = azurerm_data_factory.example.id
location = azurerm_resource_group.example.location
node_size = "Standard_D8_v3"
}
The following arguments are supported:
name
- (Required) Specifies the name of the Azure-SSIS Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
data_factory_id
- (Required) The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
location
- (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
node_size
- (Required) The size of the nodes on which the Azure-SSIS Integration Runtime runs. Valid values are: Standard_D2_v3
, Standard_D4_v3
, Standard_D8_v3
, Standard_D16_v3
, Standard_D32_v3
, Standard_D64_v3
, Standard_E2_v3
, Standard_E4_v3
, Standard_E8_v3
, Standard_E16_v3
, Standard_E32_v3
, Standard_E64_v3
, Standard_D1_v2
, Standard_D2_v2
, Standard_D3_v2
, Standard_D4_v2
, Standard_A4_v2
and Standard_A8_v2
number_of_nodes
- (Optional) Number of nodes for the Azure-SSIS Integration Runtime. Max is 10
. Defaults to 1
.
credential_name
- (Optional) The name of a Data Factory Credential that the SSIS integration will use to access data sources. For example, azurerm_data_factory_credential_user_managed_identity
max_parallel_executions_per_node
- (Optional) Defines the maximum parallel executions per node. Defaults to 1
. Max is 1
.
edition
- (Optional) The Azure-SSIS Integration Runtime edition. Valid values are Standard
and Enterprise
. Defaults to Standard
.
license_type
- (Optional) The type of the license that is used. Valid values are LicenseIncluded
and BasePrice
. Defaults to LicenseIncluded
.
catalog_info
- (Optional) A catalog_info
block as defined below.
copy_compute_scale
- (Optional) One copy_compute_scale
block as defined below.
custom_setup_script
- (Optional) A custom_setup_script
block as defined below.
express_custom_setup
- (Optional) An express_custom_setup
block as defined below.
express_vnet_integration
- (Optional) A express_vnet_integration
block as defined below.
package_store
- (Optional) One or more package_store
block as defined below.
pipeline_external_compute_scale
- (Optional) One pipeline_external_compute_scale
block as defined below.
proxy
- (Optional) A proxy
block as defined below.
vnet_integration
- (Optional) A vnet_integration
block as defined below.
description
- (Optional) Integration runtime description.
A catalog_info
block supports the following:
server_endpoint
- (Required) The endpoint of an Azure SQL Server that will be used to host the SSIS catalog.
administrator_login
- (Optional) Administrator login name for the SQL Server.
administrator_password
- (Optional) Administrator login password for the SQL Server.
pricing_tier
- (Optional) Pricing tier for the database that will be created for the SSIS catalog. Valid values are: Basic
, S0
, S1
, S2
, S3
, S4
, S6
, S7
, S9
, S12
, P1
, P2
, P4
, P6
, P11
, P15
, GP_S_Gen5_1
, GP_S_Gen5_2
, GP_S_Gen5_4
, GP_S_Gen5_6
, GP_S_Gen5_8
, GP_S_Gen5_10
, GP_S_Gen5_12
, GP_S_Gen5_14
, GP_S_Gen5_16
, GP_S_Gen5_18
, GP_S_Gen5_20
, GP_S_Gen5_24
, GP_S_Gen5_32
, GP_S_Gen5_40
, GP_Gen5_2
, GP_Gen5_4
, GP_Gen5_6
, GP_Gen5_8
, GP_Gen5_10
, GP_Gen5_12
, GP_Gen5_14
, GP_Gen5_16
, GP_Gen5_18
, GP_Gen5_20
, GP_Gen5_24
, GP_Gen5_32
, GP_Gen5_40
, GP_Gen5_80
, BC_Gen5_2
, BC_Gen5_4
, BC_Gen5_6
, BC_Gen5_8
, BC_Gen5_10
, BC_Gen5_12
, BC_Gen5_14
, BC_Gen5_16
, BC_Gen5_18
, BC_Gen5_20
, BC_Gen5_24
, BC_Gen5_32
, BC_Gen5_40
, BC_Gen5_80
, HS_Gen5_2
, HS_Gen5_4
, HS_Gen5_6
, HS_Gen5_8
, HS_Gen5_10
, HS_Gen5_12
, HS_Gen5_14
, HS_Gen5_16
, HS_Gen5_18
, HS_Gen5_20
, HS_Gen5_24
, HS_Gen5_32
, HS_Gen5_40
and HS_Gen5_80
. Mutually exclusive with elastic_pool_name
.
elastic_pool_name
- (Optional) The name of SQL elastic pool where the database will be created for the SSIS catalog. Mutually exclusive with pricing_tier
.
dual_standby_pair_name
- (Optional) The dual standby Azure-SSIS Integration Runtime pair with SSISDB failover.
A copy_compute_scale
block supports the following:
data_integration_unit
- (Optional) Specifies the data integration unit number setting reserved for copy activity execution. Supported values are multiples of 4
in range 4-256.
time_to_live
- (Optional) Specifies the time to live (in minutes) setting of integration runtime which will execute copy activity. Possible values are at least 5
.
A custom_setup_script
block supports the following:
blob_container_uri
- (Required) The blob endpoint for the container which contains a custom setup script that will be run on every node on startup. See https://docs.microsoft.com/azure/data-factory/how-to-configure-azure-ssis-ir-custom-setup for more information.
sas_token
- (Required) A container SAS token that gives access to the files. See https://docs.microsoft.com/azure/data-factory/how-to-configure-azure-ssis-ir-custom-setup for more information.
An express_custom_setup
block supports the following:
command_key
- (Optional) One or more command_key
blocks as defined below.
component
- (Optional) One or more component
blocks as defined below.
environment
- (Optional) The Environment Variables for the Azure-SSIS Integration Runtime.
powershell_version
- (Optional) The version of Azure Powershell installed for the Azure-SSIS Integration Runtime.
A express_vnet_integration
block supports the following:
subnet_id
- (Required) id of the subnet to which the nodes of the Azure-SSIS Integration Runtime will be added.A command_key
block supports the following:
target_name
- (Required) The target computer or domain name.
user_name
- (Required) The username for the target device.
password
- (Optional) The password for the target device.
key_vault_password
- (Optional) A key_vault_secret_reference
block as defined below.
A component
block supports the following:
name
- (Required) The Component Name installed for the Azure-SSIS Integration Runtime.
license
- (Optional) The license used for the Component.
key_vault_license
- (Optional) A key_vault_secret_reference
block as defined below.
A key_vault_secret_reference
block supports the following:
linked_service_name
- (Required) Specifies the name of an existing Key Vault Data Factory Linked Service.
secret_name
- (Required) Specifies the secret name in Azure Key Vault.
secret_version
- (Optional) Specifies the secret version in Azure Key Vault.
parameters
- (Optional) A map of parameters to associate with the Key Vault Data Factory Linked Service.
A package_store
block supports the following:
name
- (Required) Name of the package store.
linked_service_name
- (Required) Name of the Linked Service to associate with the packages.
A proxy
block supports the following:
self_hosted_integration_runtime_name
- (Required) Name of Self Hosted Integration Runtime as a proxy.
staging_storage_linked_service_name
- (Required) Name of Azure Blob Storage linked service to reference the staging data store to be used when moving data between self-hosted and Azure-SSIS integration runtimes.
path
- (Optional) The path in the data store to be used when moving data between Self-Hosted and Azure-SSIS Integration Runtimes.
A pipeline_external_compute_scale
block supports the following:
number_of_external_nodes
- (Optional) Specifies the number of the external nodes, which should be greater than 0
and less than 11
.
number_of_pipeline_nodes
- (Optional) Specifies the number of the pipeline nodes, which should be greater than 0
and less than 11
.
time_to_live
- (Optional) Specifies the time to live (in minutes) setting of integration runtime which will execute copy activity. Possible values are at least 5
.
A vnet_integration
block supports the following:
vnet_id
- (Optional) ID of the virtual network to which the nodes of the Azure-SSIS Integration Runtime will be added.
subnet_name
- (Optional) Name of the subnet to which the nodes of the Azure-SSIS Integration Runtime will be added.
subnet_id
- (Optional) id of the subnet to which the nodes of the Azure-SSIS Integration Runtime will be added.
public_ips
- (Optional) Static public IP addresses for the Azure-SSIS Integration Runtime. The size must be 2.In addition to the Arguments listed above - the following Attributes are exported:
id
- The ID of the Data Factory Azure-SSIS Integration Runtime.The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 30 minutes) Used when creating the Data Factory Azure-SSIS Integration Runtime.update
- (Defaults to 30 minutes) Used when updating the Data Factory Azure-SSIS Integration Runtime.read
- (Defaults to 5 minutes) Used when retrieving the Data Factory Azure-SSIS Integration Runtime.delete
- (Defaults to 30 minutes) Used when deleting the Data Factory Azure-SSIS Integration Runtime.Data Factory Azure-SSIS Integration Runtimes can be imported using the resource id
, e.g.
terraform import azurerm_data_factory_integration_runtime_azure_ssis.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/integrationruntimes/example