你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Synapse 工作区/integrationRuntimes

项目
12/17/2024

Bicep 资源定义

工作区/integrationRuntimes 资源类型可以使用目标操作进行部署：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Synapse/workspaces/integrationRuntimes 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    type: 'string'
    // For remaining properties, see IntegrationRuntime objects
  }
}

CustomSetupBase 对象

设置类型属性以指定对象的类型。

对于 CmdkeySetup，请使用：

{
  type: 'CmdkeySetup'
  typeProperties: {
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    targetName: any(Azure.Bicep.Types.Concrete.AnyType)
    userName: any(Azure.Bicep.Types.Concrete.AnyType)
  }
}

对于 ComponentSetup，请使用：

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

对于 EnvironmentVariableSetup，请使用：

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

LinkedIntegrationRuntimeType 对象

设置 authorizationType 属性以指定对象的类型。

对于密钥，请使用：

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

对于 RBAC，请使用：

{
  authorizationType: 'RBAC'
  resourceId: 'string'
}

IntegrationRuntime 对象

设置类型属性以指定对象的类型。

对于托管，请使用：

{
  managedVirtualNetwork: {
    id: 'string'
    referenceName: 'string'
    type: 'string'
  }
  type: 'Managed'
  typeProperties: {
    computeProperties: {
      dataFlowProperties: {
        computeType: 'string'
        coreCount: int
        timeToLive: int
      }
      location: 'string'
      maxParallelExecutionsPerNode: int
      nodeSize: 'string'
      numberOfNodes: int
      vNetProperties: {
        publicIPs: [
          'string'
        ]
        subnet: 'string'
        subnetId: 'string'
        vNetId: 'string'
      }
    }
    customerVirtualNetwork: {
      subnetId: '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'
    }
  }
}

对于 SelfHosted，请使用：

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

SecretBase 对象

设置类型属性以指定对象的类型。

对于 SecureString，请使用：

{
  type: 'SecureString'
  value: 'string'
}

属性值

CmdkeySetup

名字	描述	价值
类型	自定义设置的类型。	“CmdkeySetup”（必需）
typeProperties	Cmdkey 命令自定义安装类型属性。	CmdkeySetupTypeProperties （必需）

CmdkeySetupTypeProperties

名字	描述	价值
密码	数据源访问的密码。	SecretBase（必需）
targetName	数据源访问的服务器名称。	任何（必需）
userName	数据源访问的用户名。	任何（必需）

ComponentSetup

名字	描述	价值
类型	自定义设置的类型。	“ComponentSetup”（必需）
typeProperties	安装第三方组件类型属性。	LicensedComponentSetupTypeProperties（必需）

CustomSetupBase

名字	描述	价值
类型	对于 CmdkeySetup类型，设置为“CmdkeySetup”。对于 ComponentSetup类型，设置为“ComponentSetup”。对于 EnvironmentVariableSetup类型，设置为“EnvironmentVariableSetup”。	“CmdkeySetup” “ComponentSetup” “EnvironmentVariableSetup”（必需）

EntityReference

名字	描述	价值
referenceName	此引用实体的名称。	字符串
类型	此引用实体的类型。	“IntegrationRuntimeReference” “LinkedServiceReference”

EnvironmentVariableSetup

名字	描述	价值
类型	自定义设置的类型。	“EnvironmentVariableSetup”（必需）
typeProperties	添加环境变量类型属性。	EnvironmentVariableSetupTypeProperties （必需）

EnvironmentVariableSetupTypeProperties

名字	描述	价值
variableName	环境变量的名称。	string （必需）
variableValue	环境变量的值。	string （必需）

IntegrationRuntime

名字	描述	价值
描述	集成运行时说明。	字符串
类型	对于 managedIntegrationRuntime类型，设置为“Managed”类型。对于 type SelfHostedIntegrationRuntime，设置为“SelfHosted”。	“Managed” “SelfHosted”（必需）

IntegrationRuntimeComputeProperties

名字	描述	价值
dataFlowProperties	托管集成运行时的数据流属性。	IntegrationRuntimeDataFlowProperties
位置	托管集成运行时的位置。可以在 /azure/data-factory/data-factory/data-factory-data-movement-activities 中找到受支持的区域	字符串
maxParallelExecutionsPerNode	托管集成运行时每个节点的最大并行执行计数。	int 约束：最小值 = 1
nodeSize	托管集成运行时的节点大小要求。	字符串
numberOfNodes	托管集成运行时所需的节点数。	int 约束：最小值 = 1
vNetProperties	托管集成运行时的 VNet 属性。	IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

名字	描述	价值
subnetId	Azure-SSIS 集成运行时要加入的子网的 ID。	字符串

IntegrationRuntimeCustomSetupScriptProperties

名字	描述	价值
blobContainerUri	包含自定义安装脚本的 Azure Blob 容器的 URI。	字符串
sasToken	Azure Blob 容器的 SAS 令牌。	SecureString

IntegrationRuntimeDataFlowProperties

名字	描述	价值
computeType	将执行数据流作业的群集的计算类型。	“ComputeOptimized” “常规” “MemoryOptimized”
coreCount	将执行数据流作业的群集的核心计数。支持的值为：8、16、32、48、80、144 和 272。	int
timeToLive	将执行数据流作业的群集生存时间（以分钟为单位）。	int 约束：最小值 = 0

IntegrationRuntimeDataProxyProperties

名字	描述	价值
connectVia	自承载集成运行时参考。	EntityReference
路径	包含 Blob 存储中暂存数据的路径。	字符串
stagingLinkedService	暂存链接服务引用。	EntityReference

IntegrationRuntimeSsisCatalogInfo

名字	描述	价值
catalogAdminPassword	目录数据库的管理员用户帐户的密码。	SecureString
catalogAdminUserName	目录数据库的管理员用户名。	字符串约束：最小长度 = 1 最大长度 = 128
catalogPricingTier	目录数据库的定价层。可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效值	“Basic” “Premium” “PremiumRS” “Standard”
catalogServerEndpoint	目录数据库服务器 URL。	字符串

IntegrationRuntimeSsisProperties

名字	描述	价值
catalogInfo	托管专用集成运行时的目录信息。	IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties	托管专用集成运行时的自定义设置脚本属性。	IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties	托管专用集成运行时的数据代理属性。	IntegrationRuntimeDataProxyProperties
版	SSIS Integration Runtime 的版本	“Enterprise” “Standard”
expressCustomSetupProperties	没有 SSIS 集成运行时的脚本属性的自定义设置。	CustomSetupBase[]
licenseType	用于自带许可证方案的许可证类型。	“BasePrice” “LicenseIncluded”

IntegrationRuntimeVNetProperties

名字	描述	价值
publicIP	此集成运行时将使用的公共 IP 地址的资源 ID。	string[]
子	此集成运行时将加入的子网的名称。	字符串
subnetId	要加入此 Azure-SSIS 集成运行时的子网 ID。	字符串
vNetId	此集成运行时将加入的 VNet 的 ID。	字符串

LicensedComponentSetupTypeProperties

名字	描述	价值
componentName	第三方组件的名称。	string （必需）
licenseKey	用于激活组件的许可证密钥。	SecretBase

LinkedIntegrationRuntimeKeyAuthorization

名字	描述	价值
authorizationType	集成运行时共享的授权类型。	“密钥”（必需）
钥匙	用于授权的密钥。	SecureString （必需）

LinkedIntegrationRuntimeRbacAuthorization

名字	描述	价值
authorizationType	集成运行时共享的授权类型。	“RBAC”（必需）
resourceId	要共享的集成运行时的资源标识符。	string （必需）

LinkedIntegrationRuntimeType

名字	描述	价值
authorizationType	对于 LinkedIntegrationRuntimeKeyAuthorization，请设置为类型 “密钥”。对于 LinkedIntegrationRuntimeRbacAuthorization类型，设置为“RBAC”。	“Key” “RBAC”（必需）

ManagedIntegrationRuntime

名字	描述	价值
managedVirtualNetwork	托管集成运行时托管虚拟网络。	ManagedIntegrationRuntimeManagedVirtualNetworkReference
类型	集成运行时的类型。	“Managed”（必需）
typeProperties	托管集成运行时属性。	ManagedIntegrationRuntimeTypeProperties（必需）

ManagedIntegrationRuntimeManagedVirtualNetworkReference

名字	描述	价值
id	托管虚拟网络的 ID。	字符串
referenceName	托管虚拟网络的引用名称	字符串
类型	托管虚拟网络的类型。	字符串

ManagedIntegrationRuntimeTypeProperties

名字	描述	价值
computeProperties	托管集成运行时的计算资源。	IntegrationRuntimeComputeProperties
customerVirtualNetwork	Azure-SSIS 集成运行时要加入的虚拟网络的名称	IntegrationRuntimeCustomerVirtualNetwork
ssisProperties	托管集成运行时的 SSIS 属性。	IntegrationRuntimeSsisProperties

Microsoft.Synapse/workspaces/integrationRuntimes

名字	描述	价值
名字	资源名称	string （必需）
父母	在 Bicep 中，可以为子资源指定父资源。仅当子资源在父资源外部声明时，才需要添加此属性。有关详细信息，请参阅父资源外部的子资源。	类型资源的符号名称：工作区
性能	集成运行时属性。	IntegrationRuntime （必需）

SecretBase

名字	描述	价值
类型	对于 type SecureString，设置为“SecureString”。	“SecureString”（必需）

SecureString

名字	描述	价值
类型	机密的类型。	string （必需）
价值	安全字符串的值。	string （必需）

SecureString

名字	描述	价值
类型	机密的类型。	“SecureString”（必需）
价值	安全字符串的值。	string （必需）

SelfHostedIntegrationRuntime

名字	描述	价值
类型	集成运行时的类型。	“SelfHosted”（必需）
typeProperties	如果此属性不为 null，则表示这是链接的集成运行时。该属性用于访问原始集成运行时。	SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

名字	描述	价值
linkedInfo	数据工厂中的链接集成运行时类型	LinkedIntegrationRuntimeType

ARM 模板资源定义

工作区/integrationRuntimes 资源类型可以使用目标操作进行部署：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Synapse/workspaces/integrationRuntimes 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Synapse/workspaces/integrationRuntimes",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "description": "string",
    "type": "string"
    // For remaining properties, see IntegrationRuntime objects
  }
}

CustomSetupBase 对象

设置类型属性以指定对象的类型。

对于 CmdkeySetup，请使用：

{
  "type": "CmdkeySetup",
  "typeProperties": {
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "targetName": {},
    "userName": {}
  }
}

对于 ComponentSetup，请使用：

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

对于 EnvironmentVariableSetup，请使用：

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

LinkedIntegrationRuntimeType 对象

设置 authorizationType 属性以指定对象的类型。

对于密钥，请使用：

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

对于 RBAC，请使用：

{
  "authorizationType": "RBAC",
  "resourceId": "string"
}

IntegrationRuntime 对象

设置类型属性以指定对象的类型。

对于托管，请使用：

{
  "managedVirtualNetwork": {
    "id": "string",
    "referenceName": "string",
    "type": "string"
  },
  "type": "Managed",
  "typeProperties": {
    "computeProperties": {
      "dataFlowProperties": {
        "computeType": "string",
        "coreCount": "int",
        "timeToLive": "int"
      },
      "location": "string",
      "maxParallelExecutionsPerNode": "int",
      "nodeSize": "string",
      "numberOfNodes": "int",
      "vNetProperties": {
        "publicIPs": [ "string" ],
        "subnet": "string",
        "subnetId": "string",
        "vNetId": "string"
      }
    },
    "customerVirtualNetwork": {
      "subnetId": "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"
    }
  }
}

对于 SelfHosted，请使用：

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

SecretBase 对象

设置类型属性以指定对象的类型。

对于 SecureString，请使用：

{
  "type": "SecureString",
  "value": "string"
}

属性值

CmdkeySetup

名字	描述	价值
类型	自定义设置的类型。	“CmdkeySetup”（必需）
typeProperties	Cmdkey 命令自定义安装类型属性。	CmdkeySetupTypeProperties （必需）

CmdkeySetupTypeProperties

名字	描述	价值
密码	数据源访问的密码。	SecretBase（必需）
targetName	数据源访问的服务器名称。	任何（必需）
userName	数据源访问的用户名。	任何（必需）

ComponentSetup

名字	描述	价值
类型	自定义设置的类型。	“ComponentSetup”（必需）
typeProperties	安装第三方组件类型属性。	LicensedComponentSetupTypeProperties（必需）

CustomSetupBase

名字	描述	价值
类型	对于 CmdkeySetup类型，设置为“CmdkeySetup”。对于 ComponentSetup类型，设置为“ComponentSetup”。对于 EnvironmentVariableSetup类型，设置为“EnvironmentVariableSetup”。	“CmdkeySetup” “ComponentSetup” “EnvironmentVariableSetup”（必需）

EntityReference

名字	描述	价值
referenceName	此引用实体的名称。	字符串
类型	此引用实体的类型。	“IntegrationRuntimeReference” “LinkedServiceReference”

EnvironmentVariableSetup

名字	描述	价值
类型	自定义设置的类型。	“EnvironmentVariableSetup”（必需）
typeProperties	添加环境变量类型属性。	EnvironmentVariableSetupTypeProperties （必需）

EnvironmentVariableSetupTypeProperties

名字	描述	价值
variableName	环境变量的名称。	string （必需）
variableValue	环境变量的值。	string （必需）

IntegrationRuntime

名字	描述	价值
描述	集成运行时说明。	字符串
类型	对于 managedIntegrationRuntime类型，设置为“Managed”类型。对于 type SelfHostedIntegrationRuntime，设置为“SelfHosted”。	“Managed” “SelfHosted”（必需）

IntegrationRuntimeComputeProperties

名字	描述	价值
dataFlowProperties	托管集成运行时的数据流属性。	IntegrationRuntimeDataFlowProperties
位置	托管集成运行时的位置。可以在 /azure/data-factory/data-factory/data-factory-data-movement-activities 中找到受支持的区域	字符串
maxParallelExecutionsPerNode	托管集成运行时每个节点的最大并行执行计数。	int 约束：最小值 = 1
nodeSize	托管集成运行时的节点大小要求。	字符串
numberOfNodes	托管集成运行时所需的节点数。	int 约束：最小值 = 1
vNetProperties	托管集成运行时的 VNet 属性。	IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

名字	描述	价值
subnetId	Azure-SSIS 集成运行时要加入的子网的 ID。	字符串

IntegrationRuntimeCustomSetupScriptProperties

名字	描述	价值
blobContainerUri	包含自定义安装脚本的 Azure Blob 容器的 URI。	字符串
sasToken	Azure Blob 容器的 SAS 令牌。	SecureString

IntegrationRuntimeDataFlowProperties

名字	描述	价值
computeType	将执行数据流作业的群集的计算类型。	“ComputeOptimized” “常规” “MemoryOptimized”
coreCount	将执行数据流作业的群集的核心计数。支持的值为：8、16、32、48、80、144 和 272。	int
timeToLive	将执行数据流作业的群集生存时间（以分钟为单位）。	int 约束：最小值 = 0

IntegrationRuntimeDataProxyProperties

名字	描述	价值
connectVia	自承载集成运行时参考。	EntityReference
路径	包含 Blob 存储中暂存数据的路径。	字符串
stagingLinkedService	暂存链接服务引用。	EntityReference

IntegrationRuntimeSsisCatalogInfo

名字	描述	价值
catalogAdminPassword	目录数据库的管理员用户帐户的密码。	SecureString
catalogAdminUserName	目录数据库的管理员用户名。	字符串约束：最小长度 = 1 最大长度 = 128
catalogPricingTier	目录数据库的定价层。可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效值	“Basic” “Premium” “PremiumRS” “Standard”
catalogServerEndpoint	目录数据库服务器 URL。	字符串

IntegrationRuntimeSsisProperties

名字	描述	价值
catalogInfo	托管专用集成运行时的目录信息。	IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties	托管专用集成运行时的自定义设置脚本属性。	IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties	托管专用集成运行时的数据代理属性。	IntegrationRuntimeDataProxyProperties
版	SSIS Integration Runtime 的版本	“Enterprise” “Standard”
expressCustomSetupProperties	没有 SSIS 集成运行时的脚本属性的自定义设置。	CustomSetupBase[]
licenseType	用于自带许可证方案的许可证类型。	“BasePrice” “LicenseIncluded”

IntegrationRuntimeVNetProperties

名字	描述	价值
publicIP	此集成运行时将使用的公共 IP 地址的资源 ID。	string[]
子	此集成运行时将加入的子网的名称。	字符串
subnetId	要加入此 Azure-SSIS 集成运行时的子网 ID。	字符串
vNetId	此集成运行时将加入的 VNet 的 ID。	字符串

LicensedComponentSetupTypeProperties

名字	描述	价值
componentName	第三方组件的名称。	string （必需）
licenseKey	用于激活组件的许可证密钥。	SecretBase

LinkedIntegrationRuntimeKeyAuthorization

名字	描述	价值
authorizationType	集成运行时共享的授权类型。	“密钥”（必需）
钥匙	用于授权的密钥。	SecureString （必需）

LinkedIntegrationRuntimeRbacAuthorization

名字	描述	价值
authorizationType	集成运行时共享的授权类型。	“RBAC”（必需）
resourceId	要共享的集成运行时的资源标识符。	string （必需）

LinkedIntegrationRuntimeType

名字	描述	价值
authorizationType	对于 LinkedIntegrationRuntimeKeyAuthorization，请设置为类型 “密钥”。对于 LinkedIntegrationRuntimeRbacAuthorization类型，设置为“RBAC”。	“Key” “RBAC”（必需）

ManagedIntegrationRuntime

名字	描述	价值
managedVirtualNetwork	托管集成运行时托管虚拟网络。	ManagedIntegrationRuntimeManagedVirtualNetworkReference
类型	集成运行时的类型。	“Managed”（必需）
typeProperties	托管集成运行时属性。	ManagedIntegrationRuntimeTypeProperties（必需）

ManagedIntegrationRuntimeManagedVirtualNetworkReference

名字	描述	价值
id	托管虚拟网络的 ID。	字符串
referenceName	托管虚拟网络的引用名称	字符串
类型	托管虚拟网络的类型。	字符串

ManagedIntegrationRuntimeTypeProperties

名字	描述	价值
computeProperties	托管集成运行时的计算资源。	IntegrationRuntimeComputeProperties
customerVirtualNetwork	Azure-SSIS 集成运行时要加入的虚拟网络的名称	IntegrationRuntimeCustomerVirtualNetwork
ssisProperties	托管集成运行时的 SSIS 属性。	IntegrationRuntimeSsisProperties

Microsoft.Synapse/workspaces/integrationRuntimes

名字	描述	价值
apiVersion	API 版本	'2021-06-01'
名字	资源名称	string （必需）
性能	集成运行时属性。	IntegrationRuntime （必需）
类型	资源类型	“Microsoft.Synapse/workspaces/integrationRuntimes”

SecretBase

名字	描述	价值
类型	对于 type SecureString，设置为“SecureString”。	“SecureString”（必需）

SecureString

名字	描述	价值
类型	机密的类型。	string （必需）
价值	安全字符串的值。	string （必需）

SecureString

名字	描述	价值
类型	机密的类型。	“SecureString”（必需）
价值	安全字符串的值。	string （必需）

SelfHostedIntegrationRuntime

名字	描述	价值
类型	集成运行时的类型。	“SelfHosted”（必需）
typeProperties	如果此属性不为 null，则表示这是链接的集成运行时。该属性用于访问原始集成运行时。	SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

名字	描述	价值
linkedInfo	数据工厂中的链接集成运行时类型	LinkedIntegrationRuntimeType

Terraform （AzAPI 提供程序）资源定义

工作区/integrationRuntimes 资源类型可以使用目标操作进行部署：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Synapse/workspaces/integrationRuntimes 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      type = "string"
      // For remaining properties, see IntegrationRuntime objects
    }
  })
}

CustomSetupBase 对象

设置类型属性以指定对象的类型。

对于 CmdkeySetup，请使用：

{
  type = "CmdkeySetup"
  typeProperties = {
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    targetName = ?
    userName = ?
  }
}

对于 ComponentSetup，请使用：

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

对于 EnvironmentVariableSetup，请使用：

{
  type = "EnvironmentVariableSetup"
  typeProperties = {
    variableName = "string"
    variableValue = "string"
  }
}

LinkedIntegrationRuntimeType 对象

设置 authorizationType 属性以指定对象的类型。

对于密钥，请使用：

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

对于 RBAC，请使用：

{
  authorizationType = "RBAC"
  resourceId = "string"
}

IntegrationRuntime 对象

设置类型属性以指定对象的类型。

对于托管，请使用：

{
  managedVirtualNetwork = {
    id = "string"
    referenceName = "string"
    type = "string"
  }
  type = "Managed"
  typeProperties = {
    computeProperties = {
      dataFlowProperties = {
        computeType = "string"
        coreCount = int
        timeToLive = int
      }
      location = "string"
      maxParallelExecutionsPerNode = int
      nodeSize = "string"
      numberOfNodes = int
      vNetProperties = {
        publicIPs = [
          "string"
        ]
        subnet = "string"
        subnetId = "string"
        vNetId = "string"
      }
    }
    customerVirtualNetwork = {
      subnetId = "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"
    }
  }
}

对于 SelfHosted，请使用：

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

SecretBase 对象

设置类型属性以指定对象的类型。

对于 SecureString，请使用：

{
  type = "SecureString"
  value = "string"
}

属性值

CmdkeySetup

名字	描述	价值
类型	自定义设置的类型。	“CmdkeySetup”（必需）
typeProperties	Cmdkey 命令自定义安装类型属性。	CmdkeySetupTypeProperties （必需）

CmdkeySetupTypeProperties

名字	描述	价值
密码	数据源访问的密码。	SecretBase（必需）
targetName	数据源访问的服务器名称。	任何（必需）
userName	数据源访问的用户名。	任何（必需）

ComponentSetup

名字	描述	价值
类型	自定义设置的类型。	“ComponentSetup”（必需）
typeProperties	安装第三方组件类型属性。	LicensedComponentSetupTypeProperties（必需）

CustomSetupBase

名字	描述	价值
类型	对于 CmdkeySetup类型，设置为“CmdkeySetup”。对于 ComponentSetup类型，设置为“ComponentSetup”。对于 EnvironmentVariableSetup类型，设置为“EnvironmentVariableSetup”。	“CmdkeySetup” “ComponentSetup” “EnvironmentVariableSetup”（必需）

EntityReference

名字	描述	价值
referenceName	此引用实体的名称。	字符串
类型	此引用实体的类型。	“IntegrationRuntimeReference” “LinkedServiceReference”

EnvironmentVariableSetup

名字	描述	价值
类型	自定义设置的类型。	“EnvironmentVariableSetup”（必需）
typeProperties	添加环境变量类型属性。	EnvironmentVariableSetupTypeProperties （必需）

EnvironmentVariableSetupTypeProperties

名字	描述	价值
variableName	环境变量的名称。	string （必需）
variableValue	环境变量的值。	string （必需）

IntegrationRuntime

名字	描述	价值
描述	集成运行时说明。	字符串
类型	对于 managedIntegrationRuntime类型，设置为“Managed”类型。对于 type SelfHostedIntegrationRuntime，设置为“SelfHosted”。	“Managed” “SelfHosted”（必需）

IntegrationRuntimeComputeProperties

名字	描述	价值
dataFlowProperties	托管集成运行时的数据流属性。	IntegrationRuntimeDataFlowProperties
位置	托管集成运行时的位置。可以在 /azure/data-factory/data-factory/data-factory-data-movement-activities 中找到受支持的区域	字符串
maxParallelExecutionsPerNode	托管集成运行时每个节点的最大并行执行计数。	int 约束：最小值 = 1
nodeSize	托管集成运行时的节点大小要求。	字符串
numberOfNodes	托管集成运行时所需的节点数。	int 约束：最小值 = 1
vNetProperties	托管集成运行时的 VNet 属性。	IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

名字	描述	价值
subnetId	Azure-SSIS 集成运行时要加入的子网的 ID。	字符串

IntegrationRuntimeCustomSetupScriptProperties

名字	描述	价值
blobContainerUri	包含自定义安装脚本的 Azure Blob 容器的 URI。	字符串
sasToken	Azure Blob 容器的 SAS 令牌。	SecureString

IntegrationRuntimeDataFlowProperties

名字	描述	价值
computeType	将执行数据流作业的群集的计算类型。	“ComputeOptimized” “常规” “MemoryOptimized”
coreCount	将执行数据流作业的群集的核心计数。支持的值为：8、16、32、48、80、144 和 272。	int
timeToLive	将执行数据流作业的群集生存时间（以分钟为单位）。	int 约束：最小值 = 0

IntegrationRuntimeDataProxyProperties

名字	描述	价值
connectVia	自承载集成运行时参考。	EntityReference
路径	包含 Blob 存储中暂存数据的路径。	字符串
stagingLinkedService	暂存链接服务引用。	EntityReference

IntegrationRuntimeSsisCatalogInfo

名字	描述	价值
catalogAdminPassword	目录数据库的管理员用户帐户的密码。	SecureString
catalogAdminUserName	目录数据库的管理员用户名。	字符串约束：最小长度 = 1 最大长度 = 128
catalogPricingTier	目录数据库的定价层。可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效值	“Basic” “Premium” “PremiumRS” “Standard”
catalogServerEndpoint	目录数据库服务器 URL。	字符串

IntegrationRuntimeSsisProperties

名字	描述	价值
catalogInfo	托管专用集成运行时的目录信息。	IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties	托管专用集成运行时的自定义设置脚本属性。	IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties	托管专用集成运行时的数据代理属性。	IntegrationRuntimeDataProxyProperties
版	SSIS Integration Runtime 的版本	“Enterprise” “Standard”
expressCustomSetupProperties	没有 SSIS 集成运行时的脚本属性的自定义设置。	CustomSetupBase[]
licenseType	用于自带许可证方案的许可证类型。	“BasePrice” “LicenseIncluded”

IntegrationRuntimeVNetProperties

名字	描述	价值
publicIP	此集成运行时将使用的公共 IP 地址的资源 ID。	string[]
子	此集成运行时将加入的子网的名称。	字符串
subnetId	要加入此 Azure-SSIS 集成运行时的子网 ID。	字符串
vNetId	此集成运行时将加入的 VNet 的 ID。	字符串

LicensedComponentSetupTypeProperties

名字	描述	价值
componentName	第三方组件的名称。	string （必需）
licenseKey	用于激活组件的许可证密钥。	SecretBase

LinkedIntegrationRuntimeKeyAuthorization

名字	描述	价值
authorizationType	集成运行时共享的授权类型。	“密钥”（必需）
钥匙	用于授权的密钥。	SecureString （必需）

LinkedIntegrationRuntimeRbacAuthorization

名字	描述	价值
authorizationType	集成运行时共享的授权类型。	“RBAC”（必需）
resourceId	要共享的集成运行时的资源标识符。	string （必需）

LinkedIntegrationRuntimeType

名字	描述	价值
authorizationType	对于 LinkedIntegrationRuntimeKeyAuthorization，请设置为类型 “密钥”。对于 LinkedIntegrationRuntimeRbacAuthorization类型，设置为“RBAC”。	“Key” “RBAC”（必需）

ManagedIntegrationRuntime

名字	描述	价值
managedVirtualNetwork	托管集成运行时托管虚拟网络。	ManagedIntegrationRuntimeManagedVirtualNetworkReference
类型	集成运行时的类型。	“Managed”（必需）
typeProperties	托管集成运行时属性。	ManagedIntegrationRuntimeTypeProperties（必需）

ManagedIntegrationRuntimeManagedVirtualNetworkReference

名字	描述	价值
id	托管虚拟网络的 ID。	字符串
referenceName	托管虚拟网络的引用名称	字符串
类型	托管虚拟网络的类型。	字符串

ManagedIntegrationRuntimeTypeProperties

名字	描述	价值
computeProperties	托管集成运行时的计算资源。	IntegrationRuntimeComputeProperties
customerVirtualNetwork	Azure-SSIS 集成运行时要加入的虚拟网络的名称	IntegrationRuntimeCustomerVirtualNetwork
ssisProperties	托管集成运行时的 SSIS 属性。	IntegrationRuntimeSsisProperties

Microsoft.Synapse/workspaces/integrationRuntimes

名字	描述	价值
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：工作区
性能	集成运行时属性。	IntegrationRuntime （必需）
类型	资源类型	“Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01”

SecretBase

名字	描述	价值
类型	对于 type SecureString，设置为“SecureString”。	“SecureString”（必需）

SecureString

名字	描述	价值
类型	机密的类型。	string （必需）
价值	安全字符串的值。	string （必需）

SecureString

名字	描述	价值
类型	机密的类型。	“SecureString”（必需）
价值	安全字符串的值。	string （必需）

SelfHostedIntegrationRuntime

名字	描述	价值
类型	集成运行时的类型。	“SelfHosted”（必需）
typeProperties	如果此属性不为 null，则表示这是链接的集成运行时。该属性用于访问原始集成运行时。	SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

名字	描述	价值
linkedInfo	数据工厂中的链接集成运行时类型	LinkedIntegrationRuntimeType

通过

Microsoft.Synapse 工作区/integrationRuntimes

Bicep 资源定义

资源格式

CustomSetupBase 对象

LinkedIntegrationRuntimeType 对象

IntegrationRuntime 对象

SecretBase 对象

属性值

CmdkeySetup

CmdkeySetupTypeProperties

ComponentSetup

CustomSetupBase

EntityReference

EnvironmentVariableSetup

EnvironmentVariableSetupTypeProperties

IntegrationRuntime

IntegrationRuntimeComputeProperties

IntegrationRuntimeCustomerVirtualNetwork

IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeDataFlowProperties

IntegrationRuntimeDataProxyProperties

IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisProperties

IntegrationRuntimeVNetProperties

LicensedComponentSetupTypeProperties

LinkedIntegrationRuntimeKeyAuthorization

LinkedIntegrationRuntimeRbacAuthorization

LinkedIntegrationRuntimeType

ManagedIntegrationRuntime

ManagedIntegrationRuntimeManagedVirtualNetworkReference

ManagedIntegrationRuntimeTypeProperties

Microsoft.Synapse/workspaces/integrationRuntimes

SecretBase

SecureString

SecureString

SelfHostedIntegrationRuntime

SelfHostedIntegrationRuntimeTypeProperties

ARM 模板资源定义

资源格式

CustomSetupBase 对象

LinkedIntegrationRuntimeType 对象

IntegrationRuntime 对象

SecretBase 对象

属性值

CmdkeySetup

CmdkeySetupTypeProperties

ComponentSetup

CustomSetupBase

EntityReference

EnvironmentVariableSetup

EnvironmentVariableSetupTypeProperties

IntegrationRuntime

IntegrationRuntimeComputeProperties

IntegrationRuntimeCustomerVirtualNetwork

IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeDataFlowProperties

IntegrationRuntimeDataProxyProperties

IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisProperties

IntegrationRuntimeVNetProperties

LicensedComponentSetupTypeProperties

LinkedIntegrationRuntimeKeyAuthorization

LinkedIntegrationRuntimeRbacAuthorization

LinkedIntegrationRuntimeType

ManagedIntegrationRuntime

ManagedIntegrationRuntimeManagedVirtualNetworkReference

ManagedIntegrationRuntimeTypeProperties

Microsoft.Synapse/workspaces/integrationRuntimes

SecretBase

SecureString

SecureString

SelfHostedIntegrationRuntime

SelfHostedIntegrationRuntimeTypeProperties

Terraform （AzAPI 提供程序）资源定义

资源格式

CustomSetupBase 对象

LinkedIntegrationRuntimeType 对象

IntegrationRuntime 对象

SecretBase 对象