Share via

Microsoft.DataFactory factories/integrationRuntimes 2017-09-01-preview

  • Article

Bicep resource definition

The factories/integrationRuntimes resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/integrationRuntimes resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataFactory/factories/integrationRuntimes@2017-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    type: 'string'
    // For remaining properties, see IntegrationRuntime objects
  }
}

IntegrationRuntime objects

Set the type property to specify the type of object.

For Managed, use:

  type: 'Managed'
  typeProperties: {
    computeProperties: {
      location: 'string'
      maxParallelExecutionsPerNode: int
      nodeSize: 'string'
      numberOfNodes: int
      vNetProperties: {
        subnet: 'string'
        vNetId: 'string'
        {customized property}: any()
      }
      {customized property}: any()
    }
    ssisProperties: {
      catalogInfo: {
        catalogAdminPassword: {
          type: 'string'
          value: 'string'
        }
        catalogAdminUserName: 'string'
        catalogPricingTier: 'string'
        catalogServerEndpoint: 'string'
        {customized property}: any()
      }
      customSetupScriptProperties: {
        blobContainerUri: 'string'
        sasToken: {
          type: 'string'
          value: 'string'
        }
      }
      dataProxyProperties: {
        connectVia: {
          referenceName: 'string'
          type: 'string'
        }
        path: 'string'
        stagingLinkedService: {
          referenceName: 'string'
          type: 'string'
        }
      }
      edition: 'string'
      licenseType: 'string'
      {customized property}: any()
    }
  }

For SelfHosted, use:

  type: 'SelfHosted'
  typeProperties: {
    linkedInfo: {
      authorizationType: 'string'
      // For remaining properties, see LinkedIntegrationRuntimeProperties objects
    }
  }

LinkedIntegrationRuntimeProperties objects

Set the authorizationType property to specify the type of object.

For Key, use:

  authorizationType: 'Key'
  key: {
    type: 'string'
    value: 'string'
  }

For RBAC, use:

  authorizationType: 'RBAC'
  resourceId: 'string'

Property values

factories/integrationRuntimes

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)

Character limit: 3-63

Valid characters:
Alphanumerics and hyphens.

Start and end with alphanumeric.
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: factories
properties Integration runtime properties. IntegrationRuntime (required)

IntegrationRuntime

Name Description Value
description Integration runtime description. string
type Set the object type Managed
SelfHosted (required)

ManagedIntegrationRuntime

Name Description Value
type Type of integration runtime. 'Managed' (required)
typeProperties Managed integration runtime properties. ManagedIntegrationRuntimeTypeProperties (required)

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties The compute resource for managed integration runtime. IntegrationRuntimeComputeProperties
ssisProperties SSIS properties for managed integration runtime. IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

Name Description Value
location The location for managed integration runtime. The supported regions could be found on /azure/data-factory/data-factory-data-movement-activities string
maxParallelExecutionsPerNode Maximum parallel executions count per node for managed integration runtime. int

Constraints:
Min value = 1
nodeSize The node size requirement to managed integration runtime. string
numberOfNodes The required number of nodes for managed integration runtime. int

Constraints:
Min value = 1
vNetProperties VNet properties for managed integration runtime. IntegrationRuntimeVNetProperties
{customized property} For Bicep, you can use the any() function.

IntegrationRuntimeVNetProperties

Name Description Value
subnet The name of the subnet this integration runtime will join. string
vNetId The ID of the VNet that this integration runtime will join. string
{customized property} For Bicep, you can use the any() function.

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Catalog information for managed dedicated integration runtime. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Custom setup script properties for a managed dedicated integration runtime. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Data proxy properties for a managed dedicated integration runtime. IntegrationRuntimeDataProxyProperties
edition The edition for the SSIS Integration Runtime 'Enterprise'
'Standard'
licenseType License type for bringing your own license scenario. 'BasePrice'
'LicenseIncluded'
{customized property} For Bicep, you can use the any() function.

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword The password of the administrator user account of the catalog database. SecureString
catalogAdminUserName The administrator user name of catalog database. string

Constraints:
Min length = 1
Max length = 128
catalogPricingTier The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/pricing/details/sql-database/ string
catalogServerEndpoint The catalog database server URL. string
{customized property} For Bicep, you can use the any() function.

SecureString

Name Description Value
type Type of the secret. string (required)
value Value of secure string. string (required)

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri The URI of the Azure blob container that contains the custom setup script. string
sasToken The SAS token of the Azure blob container. SecureString

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia The self-hosted integration runtime reference. EntityReference
path The path to contain the staged data in the Blob storage. string
stagingLinkedService The staging linked service reference. EntityReference

EntityReference

Name Description Value
referenceName The name of this referenced entity. string
type The type of this referenced entity. 'IntegrationRuntimeReference'
'LinkedServiceReference'

SelfHostedIntegrationRuntime

Name Description Value
type Type of integration runtime. 'SelfHosted' (required)
typeProperties When this property is not null, means this is a linked integration runtime. The property is used to access original integration runtime. LinkedIntegrationRuntimeTypeProperties (required)

LinkedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo The base definition of a secret type. LinkedIntegrationRuntimeProperties

LinkedIntegrationRuntimeProperties

Name Description Value
authorizationType Set the object type Key
RBAC (required)

LinkedIntegrationRuntimeKey

Name Description Value
authorizationType Type of the secret. 'Key' (required)
key Type of the secret. SecureString (required)

LinkedIntegrationRuntimeRbac

Name Description Value
authorizationType Type of the secret. 'RBAC' (required)
resourceId The resource ID of the integration runtime to be shared. string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Self-host Integration Runtime on Azure VMs

Deploy to Azure		 This template creates a selfhost integration runtime and registers it on Azure virtual machines
Azure Data Factory with Git and managed vnet configuration

Deploy to Azure		 This template creates Azure Data Factory with Git configuration and managed virtual network.
Create a V2 data factory (SQL On-prem)

Deploy to Azure		 This template creates a V2 data factory that copies data from an on-premises SQL Server to an Azure blob storage
Provision SSIS runtime in Azure

Deploy to Azure		 This template creates a V2 data factory and then provisions an Azure SSIS integration runtime

ARM template resource definition

The factories/integrationRuntimes resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/integrationRuntimes resource, add the following JSON to your template.

{
  "type": "Microsoft.DataFactory/factories/integrationRuntimes",
  "apiVersion": "2017-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "type": "string"
    // For remaining properties, see IntegrationRuntime objects
  }
}

IntegrationRuntime objects

Set the type property to specify the type of object.

For Managed, use:

  "type": "Managed",
  "typeProperties": {
    "computeProperties": {
      "location": "string",
      "maxParallelExecutionsPerNode": "int",
      "nodeSize": "string",
      "numberOfNodes": "int",
      "vNetProperties": {
        "subnet": "string",
        "vNetId": "string",
        "{customized property}": {}
      },
      "{customized property}": {}
    },
    "ssisProperties": {
      "catalogInfo": {
        "catalogAdminPassword": {
          "type": "string",
          "value": "string"
        },
        "catalogAdminUserName": "string",
        "catalogPricingTier": "string",
        "catalogServerEndpoint": "string",
        "{customized property}": {}
      },
      "customSetupScriptProperties": {
        "blobContainerUri": "string",
        "sasToken": {
          "type": "string",
          "value": "string"
        }
      },
      "dataProxyProperties": {
        "connectVia": {
          "referenceName": "string",
          "type": "string"
        },
        "path": "string",
        "stagingLinkedService": {
          "referenceName": "string",
          "type": "string"
        }
      },
      "edition": "string",
      "licenseType": "string",
      "{customized property}": {}
    }
  }

For SelfHosted, use:

  "type": "SelfHosted",
  "typeProperties": {
    "linkedInfo": {
      "authorizationType": "string"
      // For remaining properties, see LinkedIntegrationRuntimeProperties objects
    }
  }

LinkedIntegrationRuntimeProperties objects

Set the authorizationType property to specify the type of object.

For Key, use:

  "authorizationType": "Key",
  "key": {
    "type": "string",
    "value": "string"
  }

For RBAC, use:

  "authorizationType": "RBAC",
  "resourceId": "string"

Property values

factories/integrationRuntimes

Name Description Value
type The resource type 'Microsoft.DataFactory/factories/integrationRuntimes'
apiVersion The resource api version '2017-09-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)

Character limit: 3-63

Valid characters:
Alphanumerics and hyphens.

Start and end with alphanumeric.
properties Integration runtime properties. IntegrationRuntime (required)

IntegrationRuntime

Name Description Value
description Integration runtime description. string
type Set the object type Managed
SelfHosted (required)

ManagedIntegrationRuntime

Name Description Value
type Type of integration runtime. 'Managed' (required)
typeProperties Managed integration runtime properties. ManagedIntegrationRuntimeTypeProperties (required)

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties The compute resource for managed integration runtime. IntegrationRuntimeComputeProperties
ssisProperties SSIS properties for managed integration runtime. IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

Name Description Value
location The location for managed integration runtime. The supported regions could be found on /azure/data-factory/data-factory-data-movement-activities string
maxParallelExecutionsPerNode Maximum parallel executions count per node for managed integration runtime. int

Constraints:
Min value = 1
nodeSize The node size requirement to managed integration runtime. string
numberOfNodes The required number of nodes for managed integration runtime. int

Constraints:
Min value = 1
vNetProperties VNet properties for managed integration runtime. IntegrationRuntimeVNetProperties
{customized property}

IntegrationRuntimeVNetProperties

Name Description Value
subnet The name of the subnet this integration runtime will join. string
vNetId The ID of the VNet that this integration runtime will join. string
{customized property}

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Catalog information for managed dedicated integration runtime. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Custom setup script properties for a managed dedicated integration runtime. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Data proxy properties for a managed dedicated integration runtime. IntegrationRuntimeDataProxyProperties
edition The edition for the SSIS Integration Runtime 'Enterprise'
'Standard'
licenseType License type for bringing your own license scenario. 'BasePrice'
'LicenseIncluded'
{customized property}

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword The password of the administrator user account of the catalog database. SecureString
catalogAdminUserName The administrator user name of catalog database. string

Constraints:
Min length = 1
Max length = 128
catalogPricingTier The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/pricing/details/sql-database/ string
catalogServerEndpoint The catalog database server URL. string
{customized property}

SecureString

Name Description Value
type Type of the secret. string (required)
value Value of secure string. string (required)

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri The URI of the Azure blob container that contains the custom setup script. string
sasToken The SAS token of the Azure blob container. SecureString

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia The self-hosted integration runtime reference. EntityReference
path The path to contain the staged data in the Blob storage. string
stagingLinkedService The staging linked service reference. EntityReference

EntityReference

Name Description Value
referenceName The name of this referenced entity. string
type The type of this referenced entity. 'IntegrationRuntimeReference'
'LinkedServiceReference'

SelfHostedIntegrationRuntime

Name Description Value
type Type of integration runtime. 'SelfHosted' (required)
typeProperties When this property is not null, means this is a linked integration runtime. The property is used to access original integration runtime. LinkedIntegrationRuntimeTypeProperties (required)

LinkedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo The base definition of a secret type. LinkedIntegrationRuntimeProperties

LinkedIntegrationRuntimeProperties

Name Description Value
authorizationType Set the object type Key
RBAC (required)

LinkedIntegrationRuntimeKey

Name Description Value
authorizationType Type of the secret. 'Key' (required)
key Type of the secret. SecureString (required)

LinkedIntegrationRuntimeRbac

Name Description Value
authorizationType Type of the secret. 'RBAC' (required)
resourceId The resource ID of the integration runtime to be shared. string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Self-host Integration Runtime on Azure VMs

Deploy to Azure		 This template creates a selfhost integration runtime and registers it on Azure virtual machines
Azure Data Factory with Git and managed vnet configuration

Deploy to Azure		 This template creates Azure Data Factory with Git configuration and managed virtual network.
Create a V2 data factory (SQL On-prem)

Deploy to Azure		 This template creates a V2 data factory that copies data from an on-premises SQL Server to an Azure blob storage
Provision SSIS runtime in Azure

Deploy to Azure		 This template creates a V2 data factory and then provisions an Azure SSIS integration runtime

Terraform (AzAPI provider) resource definition

The factories/integrationRuntimes resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/integrationRuntimes resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/integrationRuntimes@2017-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      type = "string"
      // For remaining properties, see IntegrationRuntime objects
    }
  })
}

IntegrationRuntime objects

Set the type property to specify the type of object.

For Managed, use:

  type = "Managed"
  typeProperties = {
    computeProperties = {
      location = "string"
      maxParallelExecutionsPerNode = int
      nodeSize = "string"
      numberOfNodes = int
      vNetProperties = {
        subnet = "string"
        vNetId = "string"
      }
    }
    ssisProperties = {
      catalogInfo = {
        catalogAdminPassword = {
          type = "string"
          value = "string"
        }
        catalogAdminUserName = "string"
        catalogPricingTier = "string"
        catalogServerEndpoint = "string"
      }
      customSetupScriptProperties = {
        blobContainerUri = "string"
        sasToken = {
          type = "string"
          value = "string"
        }
      }
      dataProxyProperties = {
        connectVia = {
          referenceName = "string"
          type = "string"
        }
        path = "string"
        stagingLinkedService = {
          referenceName = "string"
          type = "string"
        }
      }
      edition = "string"
      licenseType = "string"
    }
  }

For SelfHosted, use:

  type = "SelfHosted"
  typeProperties = {
    linkedInfo = {
      authorizationType = "string"
      // For remaining properties, see LinkedIntegrationRuntimeProperties objects
    }
  }

LinkedIntegrationRuntimeProperties objects

Set the authorizationType property to specify the type of object.

For Key, use:

  authorizationType = "Key"
  key = {
    type = "string"
    value = "string"
  }

For RBAC, use:

  authorizationType = "RBAC"
  resourceId = "string"

Property values

factories/integrationRuntimes

Name Description Value
type The resource type "Microsoft.DataFactory/factories/integrationRuntimes@2017-09-01-preview"
name The resource name string (required)

Character limit: 3-63

Valid characters:
Alphanumerics and hyphens.

Start and end with alphanumeric.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: factories
properties Integration runtime properties. IntegrationRuntime (required)

IntegrationRuntime

Name Description Value
description Integration runtime description. string
type Set the object type Managed
SelfHosted (required)

ManagedIntegrationRuntime

Name Description Value
type Type of integration runtime. "Managed" (required)
typeProperties Managed integration runtime properties. ManagedIntegrationRuntimeTypeProperties (required)

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties The compute resource for managed integration runtime. IntegrationRuntimeComputeProperties
ssisProperties SSIS properties for managed integration runtime. IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

Name Description Value
location The location for managed integration runtime. The supported regions could be found on /azure/data-factory/data-factory-data-movement-activities string
maxParallelExecutionsPerNode Maximum parallel executions count per node for managed integration runtime. int

Constraints:
Min value = 1
nodeSize The node size requirement to managed integration runtime. string
numberOfNodes The required number of nodes for managed integration runtime. int

Constraints:
Min value = 1
vNetProperties VNet properties for managed integration runtime. IntegrationRuntimeVNetProperties
{customized property}

IntegrationRuntimeVNetProperties

Name Description Value
subnet The name of the subnet this integration runtime will join. string
vNetId The ID of the VNet that this integration runtime will join. string
{customized property}

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Catalog information for managed dedicated integration runtime. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Custom setup script properties for a managed dedicated integration runtime. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Data proxy properties for a managed dedicated integration runtime. IntegrationRuntimeDataProxyProperties
edition The edition for the SSIS Integration Runtime "Enterprise"
"Standard"
licenseType License type for bringing your own license scenario. "BasePrice"
"LicenseIncluded"
{customized property}

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword The password of the administrator user account of the catalog database. SecureString
catalogAdminUserName The administrator user name of catalog database. string

Constraints:
Min length = 1
Max length = 128
catalogPricingTier The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/pricing/details/sql-database/ string
catalogServerEndpoint The catalog database server URL. string
{customized property}

SecureString

Name Description Value
type Type of the secret. string (required)
value Value of secure string. string (required)

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri The URI of the Azure blob container that contains the custom setup script. string
sasToken The SAS token of the Azure blob container. SecureString

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia The self-hosted integration runtime reference. EntityReference
path The path to contain the staged data in the Blob storage. string
stagingLinkedService The staging linked service reference. EntityReference

EntityReference

Name Description Value
referenceName The name of this referenced entity. string
type The type of this referenced entity. "IntegrationRuntimeReference"
"LinkedServiceReference"

SelfHostedIntegrationRuntime

Name Description Value
type Type of integration runtime. "SelfHosted" (required)
typeProperties When this property is not null, means this is a linked integration runtime. The property is used to access original integration runtime. LinkedIntegrationRuntimeTypeProperties (required)

LinkedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo The base definition of a secret type. LinkedIntegrationRuntimeProperties

LinkedIntegrationRuntimeProperties

Name Description Value
authorizationType Set the object type Key
RBAC (required)

LinkedIntegrationRuntimeKey

Name Description Value
authorizationType Type of the secret. "Key" (required)
key Type of the secret. SecureString (required)

LinkedIntegrationRuntimeRbac

Name Description Value
authorizationType Type of the secret. "RBAC" (required)
resourceId The resource ID of the integration runtime to be shared. string (required)