Microsoft.Synapse workspaces/integrationRuntimes 2021-04-01-preview

The workspaces/integrationRuntimes resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Synapse/workspaces/integrationRuntimes resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Synapse/workspaces/integrationRuntimes@2021-04-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: {
      dataFlowProperties: {
        computeType: 'string'
        coreCount: int
        timeToLive: int
      }
      location: 'string'
      maxParallelExecutionsPerNode: int
      nodeSize: 'string'
      numberOfNodes: int
      vNetProperties: {
        publicIPs: [ 'string' ]
        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'
      expressCustomSetupProperties: [
        {
          type: 'string'
          // For remaining properties, see CustomSetupBase objects
        }
      ]
      licenseType: 'string'
    }
  }

For SelfHosted, use:

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

CustomSetupBase objects

Set the type property to specify the type of object.

For CmdkeySetup, use:

  type: 'CmdkeySetup'
  typeProperties: {
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    targetName: any()
    userName: any()
  }

For ComponentSetup, use:

  type: 'ComponentSetup'
  typeProperties: {
    componentName: 'string'
    licenseKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
  }

For EnvironmentVariableSetup, use:

  type: 'EnvironmentVariableSetup'
  typeProperties: {
    variableName: 'string'
    variableValue: 'string'
  }

SecretBase objects

Set the type property to specify the type of object.

For SecureString, use:

  type: 'SecureString'
  value: 'string'

LinkedIntegrationRuntimeType 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

workspaces/integrationRuntimes

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Synapse/workspaces/integrationRuntimes'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-04-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Azure Synapse nested object which serves as a compute resource for activities. IntegrationRuntime (required)

IntegrationRuntime

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

ManagedIntegrationRuntime

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

ManagedIntegrationRuntimeTypeProperties

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

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties Data flow properties for managed integration runtime. IntegrationRuntimeDataFlowProperties
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
nodeSize The node size requirement to managed integration runtime. string
numberOfNodes The required number of nodes for managed integration runtime. int
vNetProperties VNet properties for managed integration runtime. IntegrationRuntimeVNetProperties

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType Compute type of the cluster which will execute data flow job. 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272. int
timeToLive Time to live (in minutes) setting of the cluster which will execute data flow job. int

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs Resource IDs of the public IP addresses that this integration runtime will use. string[]
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

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'
expressCustomSetupProperties Custom setup without script properties for a SSIS integration runtime. CustomSetupBase[]
licenseType License type for bringing your own license scenario. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. SecureString
catalogAdminUserName The administrator user name of catalog database. string
catalogPricingTier The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint The catalog database server URL. string

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 Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. SecureString

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia The entity reference. EntityReference
path The path to contain the staged data in the Blob storage. string
stagingLinkedService The entity reference. EntityReference

EntityReference

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

CustomSetupBase

Name Description Value
type Set the object type CmdkeySetup
ComponentSetup
EnvironmentVariableSetup

CmdkeySetup

Name Description Value
type The type of custom setup. 'CmdkeySetup'
typeProperties Cmdkey command custom setup type properties. CmdkeySetupTypeProperties (required)

CmdkeySetupTypeProperties

Name Description Value
password The base definition of a secret type. SecretBase (required)
targetName Any object For Bicep, you can use the any() function.(required)
userName Any object For Bicep, you can use the any() function.(required)

SecretBase

Name Description Value
type Set the object type SecureString

ComponentSetup

Name Description Value
type The type of custom setup. 'ComponentSetup'
typeProperties Installation of licensed component setup type properties. LicensedComponentSetupTypeProperties (required)

LicensedComponentSetupTypeProperties

Name Description Value
componentName The name of the 3rd party component. string (required)
licenseKey The base definition of a secret type. SecretBase

EnvironmentVariableSetup

Name Description Value
type The type of custom setup. 'EnvironmentVariableSetup'
typeProperties Environment variable custom setup type properties. EnvironmentVariableSetupTypeProperties (required)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName The name of the environment variable. string (required)
variableValue The value of the environment variable. string (required)

SelfHostedIntegrationRuntime

Name Description Value
type Type of integration runtime. 'SelfHosted'
typeProperties The self-hosted integration runtime properties. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo The base definition of a linked integration runtime. LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

Name Description Value
authorizationType Set the object type Key
RBAC

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType The authorization type for integration runtime sharing. 'Key'
key Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. SecureString (required)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType The authorization type for integration runtime sharing. 'RBAC'
resourceId The resource identifier of the integration runtime to be shared. string (required)