Microsoft.Synapse workspaces/integrationRuntimes

Template format

To create a Microsoft.Synapse/workspaces/integrationRuntimes resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Synapse/workspaces/integrationRuntimes",
  "apiVersion": "2021-03-01",
  "properties": {
    "description": "string",
    <see-variations-below>
  }
}

For self-hosted, use:

"type": "SelfHosted",
"typeProperties": {
  "linkedInfo": {
    <see-auth-variations>
  }
}

For key authorization, use:

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

For RBAC authorization, use:

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

For managed, use:

"type": "Managed",
"typeProperties": {
  "ssisProperties": {
    "customSetupScriptProperties": {
      "blobContainerUri": "string",
      "sasToken": "string"
    },
    "dataProxyProperties": {
      "connectVia": {
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "path": "string",
      "stagingLinkedService": {
        "referenceName": "string",
        "type": "string"
      }
    },
    "edition": "Enterprise",
    "expressCustomSetupProperties": [
      <see-setup-variations>
    ],
    "catalogInfo": {
      "catalogAdminPassword": {
        "type": "SecureString",
        "value": "string"
      },
      "catalogAdminUserName": "string",
      "catalogPricingTier": "Basic",
      "catalogServerEndpoint": "string"
    }
  },
  "computeProperties": {
    "location": "string",
    "maxParallelExecutionsPerNode": "int",
    "nodeSize": "int",
    "numberOfNodes": "int",
    "vNetProperties": {
      "publicIPs": [
        "string"
      ],
      "subnet": "string",
      "vNetId": "string"
    },
    "dataFlowProperties": {
      "computeType": "General",
      "coreCount": "int",
      "timeToLive": "int"
    }
  }
}

For CmdkeySetup, use:

{
  "type": "CmdkeySetup",
  "typeProperties": {
    "targetName": "object",
    "userName": "object",
    "password": {
      "type": "SecureString",
      "value": "string"
    }
  }
}

For ComponentSetup, use:

{
  "type": "ComponentSetup",
  "typeProperties": {
    "componentName": "string",
    "licenseKey": "string"
  }
}

For EnvironmentVariableSetup, use:

{
  "type": "EnvironmentVariableSetup",
  "typeProperties": {
    "variableName": "string",
    "variableValue": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Synapse/workspaces/integrationRuntimes object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Integration runtime name
type enum Yes For JSON -integrationRuntimes
-or-
Microsoft.Synapse/workspaces/integrationRuntimes

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2021-03-01
properties object Yes Integration runtime properties. - IntegrationRuntimeModel object

IntegrationRuntimeModel object

Name Type Required Value
additionalProperties object No Unmatched properties from the message are deserialized this collection
description string No Integration runtime description.
type string Yes Type of integration runtime. - Managed, SelfHosted

SelfHosted object

Name Type Required Value
typeProperties object Yes The self-hosted integration runtime properties.
linkedInfo object Yes Linked integration runtime type from data factory. - Key object, RBAC object

Key object

Name Type Required Value
authorizationType string Yes The authorization type for integration runtime sharing. - Key
key object Yes The key used for authorization. - SecureString object

RBAC object

Name Type Required Value
authorizationType string Yes The authorization type for integration runtime sharing. - RBAC
resourceId string Yes The resource identifier of the integration runtime to be shared.

Managed object

Name Type Required Value
typeProperties object Yes Managed integration runtime properties. - Managed Integration object

Managed Integration object

Name Type Required Value
computeProperties object No The compute resource for managed integration runtime. - Compute properties object
ssisProperties object No SSIS properties for managed integration runtime. - SSIS properties object

Compute properties object

Name Type Required Value
location string No The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/azure/data-factory/data-factory-data-movement-activities
nodeSize string No The node size requirement to managed integration runtime.
numberOfNodes integer No The required number of nodes for managed integration runtime.
maxParallelExecutionsPerNode integer No Maximum parallel executions count per node for managed integration runtime.
dataFlowProperties object No Data flow properties for managed integration runtime. - Dataflow object
vNetProperties object No VNet properties for managed integration runtime. - VNet properties object

SSIS properties object

Name Type Required Value
catalogInfo object No Catalog information for managed dedicated integration runtime. - Catalog Info object
licenseType string No License type for bringing your own license scenario. - BasePrice, LicenseIncluded
customSetupScriptProperties object No Custom setup script properties for a managed dedicated integration runtime. - Custom setup script object
dataProxyProperties object No Data proxy properties for a managed dedicated integration runtime. - Data proxy object
edition string No The edition for the SSIS Integration Runtime - Standard, Enterprise
expressCustomSetupProperties array No Custom setup without script properties for a SSIS integration runtime. - Custom setup object

Dataflow object

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

VNet properties object

Name Type Required Value
vNetId string No The ID of the VNet that this integration runtime will join.
subnet string No The name of the subnet this integration runtime will join.
publicIPs array No Resource IDs of the public IP addresses that this integration runtime will use. - string

Catalog Info object

Name Type Required Value
catalogServerEndpoint string No The catalog database server URL.
catalogAdminUserName string No The administrator user name of catalog database.
catalogAdminPassword string No The password of the administrator user account of the catalog database. - SecureString object
catalogPricingTier string No The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/pricing/details/sql-database/ - Basic, Standard, Premium, PremiumRS

SecureString object

Name Type Required Value
type string Yes Type of the secret. - SecureString
value string Yes Value of secure string.

Custom setup script object

Name Type Required Value
blobContainerUri string No The URI of the Azure blob container that contains the custom setup script.
sasToken object No The SAS token of the Azure blob container. - SecureString object

Data proxy object

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

EntityReference object

Name Type Required Value
type string No The type of this referenced entity. - IntegrationRuntimeReference, LinkedServiceReference
referenceName string No The name of this referenced entity.

Custom setup object

Name Type Required Value
type string Yes The type of custom setup. - CmdkeySetup, EnvironmentVariableSetup, ComponentSetup
typeProperties object Yes Custom setup type properties - CmdkeySetup, EnvironmentVariableSetup, ComponentSetup

CmdkeySetup

Name Type Required Value
targetName object Yes The server name of data source access.
userName object Yes The user name of data source access.
password object Yes The password of data source access. - SecureString object

EnvironmentVariableSetup

Name Type Required Value
variableName string Yes The name of the environment variable.
variableValue string Yes The value of the environment variable.

ComponentSetup

Name Type Required Value
componentName string Yes The name of the 3rd party component.
licenseKey object No The license key to activate the component. - SecureString object