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

Article
12/09/2024

Bicep resource definition

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

Resource groups - See resource group deployment commands

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' = {
  parent: resourceSymbolicName
  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'
      }
    }
    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

EntityReference

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

IntegrationRuntime

Name	Description	Value
description	Integration runtime description.	string
type	Set to 'Managed' for type ManagedIntegrationRuntime. Set to 'SelfHosted' for type SelfHostedIntegrationRuntime.	'Managed' 'SelfHosted' (required)

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

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

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/en-us/pricing/details/sql-database/	string
catalogServerEndpoint	The catalog database server URL.	string

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'

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

LinkedIntegrationRuntimeKey

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

LinkedIntegrationRuntimeProperties

Name	Description	Value
authorizationType	Set to 'Key' for type LinkedIntegrationRuntimeKey. Set to 'RBAC' for type LinkedIntegrationRuntimeRbac.	'Key' 'RBAC' (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)

LinkedIntegrationRuntimeTypeProperties

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

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

Microsoft.DataFactory/factories/integrationRuntimes

Name	Description	Value
name	The resource name	string Constraints: Min length = 3 Max length = 63 Pattern = `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$` (required)
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)

SecureString

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

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)

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File	Description
Azure Data Factory with Git and managed vnet configuration	This template creates Azure Data Factory with Git configuration and managed virtual network.
Self-host Integration Runtime on Azure VMs	This template creates a selfhost integration runtime and registers it on Azure virtual machines

ARM template resource definition

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

Resource groups - See resource group deployment commands

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"
      }
    },
    "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

EntityReference

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

IntegrationRuntime

Name	Description	Value
description	Integration runtime description.	string
type	Set to 'Managed' for type ManagedIntegrationRuntime. Set to 'SelfHosted' for type SelfHostedIntegrationRuntime.	'Managed' 'SelfHosted' (required)

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

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

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/en-us/pricing/details/sql-database/	string
catalogServerEndpoint	The catalog database server URL.	string

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'

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

LinkedIntegrationRuntimeKey

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

LinkedIntegrationRuntimeProperties

Name	Description	Value
authorizationType	Set to 'Key' for type LinkedIntegrationRuntimeKey. Set to 'RBAC' for type LinkedIntegrationRuntimeRbac.	'Key' 'RBAC' (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)

LinkedIntegrationRuntimeTypeProperties

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

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

Microsoft.DataFactory/factories/integrationRuntimes

Name	Description	Value
apiVersion	The api version	'2017-09-01-preview'
name	The resource name	string Constraints: Min length = 3 Max length = 63 Pattern = `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$` (required)
properties	Integration runtime properties.	IntegrationRuntime (required)
type	The resource type	'Microsoft.DataFactory/factories/integrationRuntimes'

SecureString

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

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)

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Azure Data Factory with Git and managed vnet configuration	This template creates Azure Data Factory with Git configuration and managed virtual network.
Self-host Integration Runtime on Azure VMs	This template creates a selfhost integration runtime and registers it on Azure virtual machines

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"
  body = {
    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

EntityReference

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

IntegrationRuntime

Name	Description	Value
description	Integration runtime description.	string
type	Set to 'Managed' for type ManagedIntegrationRuntime. Set to 'SelfHosted' for type SelfHostedIntegrationRuntime.	'Managed' 'SelfHosted' (required)

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

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

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/en-us/pricing/details/sql-database/	string
catalogServerEndpoint	The catalog database server URL.	string

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'

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

LinkedIntegrationRuntimeKey

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

LinkedIntegrationRuntimeProperties

Name	Description	Value
authorizationType	Set to 'Key' for type LinkedIntegrationRuntimeKey. Set to 'RBAC' for type LinkedIntegrationRuntimeRbac.	'Key' 'RBAC' (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)

LinkedIntegrationRuntimeTypeProperties

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

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

Microsoft.DataFactory/factories/integrationRuntimes

Name	Description	Value
name	The resource name	string Constraints: Min length = 3 Max length = 63 Pattern = `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$` (required)
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)
type	The resource type	"Microsoft.DataFactory/factories/integrationRuntimes@2017-09-01-preview"

SecureString

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

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)

Share via

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

Bicep resource definition

Resource format

IntegrationRuntime objects

LinkedIntegrationRuntimeProperties objects

Property Values

EntityReference

IntegrationRuntime

IntegrationRuntimeComputeProperties

IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeDataProxyProperties

IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisProperties

IntegrationRuntimeVNetProperties

LinkedIntegrationRuntimeKey

LinkedIntegrationRuntimeProperties

LinkedIntegrationRuntimeRbac

LinkedIntegrationRuntimeTypeProperties

ManagedIntegrationRuntime

ManagedIntegrationRuntimeTypeProperties

Microsoft.DataFactory/factories/integrationRuntimes

SecureString

SelfHostedIntegrationRuntime

Usage Examples

Azure Quickstart Samples

ARM template resource definition

Resource format

IntegrationRuntime objects

LinkedIntegrationRuntimeProperties objects

Property Values

EntityReference

IntegrationRuntime

IntegrationRuntimeComputeProperties

IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeDataProxyProperties

IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisProperties

IntegrationRuntimeVNetProperties

LinkedIntegrationRuntimeKey

LinkedIntegrationRuntimeProperties

LinkedIntegrationRuntimeRbac

LinkedIntegrationRuntimeTypeProperties

ManagedIntegrationRuntime

ManagedIntegrationRuntimeTypeProperties

Microsoft.DataFactory/factories/integrationRuntimes

SecureString

SelfHostedIntegrationRuntime

Usage Examples

Azure Quickstart Templates

Terraform (AzAPI provider) resource definition

Resource format

IntegrationRuntime objects

LinkedIntegrationRuntimeProperties objects

Property Values

EntityReference

IntegrationRuntime

IntegrationRuntimeComputeProperties

IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeDataProxyProperties

IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisProperties

IntegrationRuntimeVNetProperties

LinkedIntegrationRuntimeKey

LinkedIntegrationRuntimeProperties

LinkedIntegrationRuntimeRbac

LinkedIntegrationRuntimeTypeProperties

ManagedIntegrationRuntime

ManagedIntegrationRuntimeTypeProperties

Microsoft.DataFactory/factories/integrationRuntimes

SecureString

SelfHostedIntegrationRuntime

Feedback

Additional resources