你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
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
}
}
IntegrationRuntime 对象
设置 type 属性以指定对象的类型。
对于 托管,请使用:
{
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 对象
设置 type 属性以指定对象的类型。
对于 SecureString,请使用:
{
type: 'SecureString'
value: 'string'
}
CustomSetupBase 对象
设置 type 属性以指定对象的类型。
对于 CmdkeySetup,请使用:
{
type: 'CmdkeySetup'
typeProperties: {
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
targetName: any(...)
userName: any(...)
}
}
对于 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'
}
属性值
Microsoft.Synapse/workspaces/integrationRuntimes
| Name | Description | Value |
|---|---|---|
| name | 资源名称 | string (必需) |
| 父级 | 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。 有关详细信息,请参阅 父资源外部的子资源。 |
类型资源的符号名称:工作区 |
| properties | 集成运行时属性。 | IntegrationRuntime (必需) |
CmdkeySetup
| Name | Description | Value |
|---|---|---|
| 类型 | 自定义设置的类型。 | “CmdkeySetup”(必需) |
| typeProperties | Cmdkey 命令自定义安装类型属性。 | CmdkeySetupTypeProperties (必需) |
CmdkeySetupTypeProperties
| Name | Description | Value |
|---|---|---|
| 密码 | 数据源访问的密码。 | SecretBase (必需) |
| targetName | 数据源访问的服务器名称。 | 任何(必需) |
| userName | 数据源访问的用户名。 | 任何(必需) |
ComponentSetup
| Name | Description | Value |
|---|---|---|
| 类型 | 自定义设置的类型。 | 'ComponentSetup'(必需) |
| typeProperties | 安装第三方组件类型属性。 | LicensedComponentSetupTypeProperties (必需) |
CustomSetupBase
| Name | Description | Value |
|---|---|---|
| 类型 | 对于 类型 CmdkeySetup,设置为“CmdkeySetup”。 将 类型 ComponentSetup 设置为“ComponentSetup”。 将 EnvironmentVariableSetup 类型设置为“EnvironmentVariableSetup”。 | 'CmdkeySetup' 'ComponentSetup' 'EnvironmentVariableSetup'(必需) |
EntityReference
| Name | Description | Value |
|---|---|---|
| referenceName | 此引用实体的名称。 | 字符串 |
| 类型 | 此引用实体的类型。 | 'IntegrationRuntimeReference' 'LinkedServiceReference' |
EnvironmentVariableSetup
| Name | Description | Value |
|---|---|---|
| 类型 | 自定义设置的类型。 | 'EnvironmentVariableSetup'(必需) |
| typeProperties | 添加环境变量类型属性。 | EnvironmentVariableSetupTypeProperties (必需) |
EnvironmentVariableSetupTypeProperties
| Name | Description | Value |
|---|---|---|
| variableName | 环境变量的名称。 | string (必需) |
| variableValue | 环境变量的值。 | string (必需) |
IntegrationRuntime
| Name | Description | Value |
|---|---|---|
| description | 集成运行时说明。 | 字符串 |
| 类型 | 将类型 ManagedIntegrationRuntime 设置为“托管”。 将 类型 SelfHostedIntegrationRuntime 设置为“SelfHosted”。 | 'Managed' “自托管”(必需) |
IntegrationRuntimeComputeProperties
| Name | Description | Value |
|---|---|---|
| dataFlowProperties | 托管集成运行时的数据流属性。 | IntegrationRuntimeDataFlowProperties |
| 位置 | 托管集成运行时的位置。 可以在 /azure/data-factory/data-factory/data-factory-data-movement-activities 中找到受支持的区域 | 字符串 |
| maxParallelExecutionsPerNode | 托管集成运行时每个节点的最大并行执行计数。 | int Constraints: 最小值 = 1 |
| nodeSize | 托管集成运行时的节点大小要求。 | 字符串 |
| numberOfNodes | 托管集成运行时所需的节点数。 | int Constraints: 最小值 = 1 |
| vNetProperties | 托管集成运行时的 VNet 属性。 | IntegrationRuntimeVNetProperties |
IntegrationRuntimeCustomerVirtualNetwork
| Name | Description | Value |
|---|---|---|
| subnetId | Azure-SSIS 集成运行时要加入的子网的 ID。 | 字符串 |
IntegrationRuntimeCustomSetupScriptProperties
| Name | Description | Value |
|---|---|---|
| blobContainerUri | 包含自定义安装脚本的 Azure Blob 容器的 URI。 | 字符串 |
| sasToken | Azure Blob 容器的 SAS 令牌。 | SecureString |
IntegrationRuntimeDataFlowProperties
| Name | Description | Value |
|---|---|---|
| computeType | 将执行数据流作业的群集的计算类型。 | 'ComputeOptimized' 'General' 'MemoryOptimized' |
| coreCount | 将执行数据流作业的群集的核心计数。 支持的值为:8、16、32、48、80、144 和 272。 | int |
| timeToLive | 将执行数据流作业的群集生存时间(以分钟为单位)。 | int Constraints: 最小值 = 0 |
IntegrationRuntimeDataProxyProperties
| Name | Description | Value |
|---|---|---|
| connectVia | 自承载集成运行时参考。 | EntityReference |
| 路径 | 包含 Blob 存储中暂存数据的路径。 | 字符串 |
| stagingLinkedService | 暂存链接服务引用。 | EntityReference |
IntegrationRuntimeSsisCatalogInfo
| Name | Description | Value |
|---|---|---|
| catalogAdminPassword | 目录数据库的管理员用户帐户的密码。 | SecureString |
| catalogAdminUserName | 目录数据库的管理员用户名。 | string Constraints: 最小长度 = 1 最大长度 = 128 |
| catalogPricingTier | 目录数据库的定价层。 可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效值 | 'Basic' 'Premium' 'PremiumRS' 'Standard' |
| catalogServerEndpoint | 目录数据库服务器 URL。 | 字符串 |
IntegrationRuntimeSsisProperties
| Name | Description | Value |
|---|---|---|
| catalogInfo | 托管专用集成运行时的目录信息。 | IntegrationRuntimeSsisCatalogInfo |
| customSetupScriptProperties | 托管专用集成运行时的自定义设置脚本属性。 | IntegrationRuntimeCustomSetupScriptProperties |
| dataProxyProperties | 托管专用集成运行时的数据代理属性。 | IntegrationRuntimeDataProxyProperties |
| edition | SSIS Integration Runtime 的版本 | 'Enterprise' 'Standard' |
| expressCustomSetupProperties | 没有 SSIS 集成运行时的脚本属性的自定义设置。 | CustomSetupBase[] |
| licenseType | 用于自带许可证方案的许可证类型。 | 'BasePrice' 'LicenseIncluded' |
IntegrationRuntimeVNetProperties
| Name | Description | Value |
|---|---|---|
| publicIPs | 此集成运行时将使用的公共 IP 地址的资源 ID。 | string[] |
| 子网 | 此集成运行时将加入的子网的名称。 | 字符串 |
| subnetId | 要加入此 Azure-SSIS 集成运行时的子网 ID。 | 字符串 |
| vNetId | 此集成运行时将加入的 VNet 的 ID。 | 字符串 |
LicensedComponentSetupTypeProperties
| Name | Description | Value |
|---|---|---|
| componentName | 第三方组件的名称。 | string (必需) |
| licenseKey | 用于激活组件的许可证密钥。 | SecretBase |
LinkedIntegrationRuntimeKeyAuthorization
| Name | Description | Value |
|---|---|---|
| authorizationType | 集成运行时共享的授权类型。 | “键”(必填) |
| 关键值 | 用于授权的密钥。 | SecureString (必需) |
LinkedIntegrationRuntimeRbacAuthorization
| Name | Description | Value |
|---|---|---|
| authorizationType | 集成运行时共享的授权类型。 | 'RBAC'(必需) |
| resourceId | 要共享的集成运行时的资源标识符。 | string (必需) |
LinkedIntegrationRuntimeType
| Name | Description | Value |
|---|---|---|
| authorizationType | 将 LinkedIntegrationRuntimeKeyAuthorization 类型设置为“Key”。 将 LinkedIntegrationRuntimeRbacAuthorization 类型设置为“RBAC”。 | 'Key' 'RBAC'(必需) |
ManagedIntegrationRuntime
| Name | Description | Value |
|---|---|---|
| managedVirtualNetwork | 托管集成运行时托管虚拟网络。 | ManagedIntegrationRuntimeManagedVirtualNetworkReference |
| 类型 | 集成运行时的类型。 | “托管”(必填) |
| typeProperties | 托管集成运行时属性。 | ManagedIntegrationRuntimeTypeProperties (必需) |
ManagedIntegrationRuntimeManagedVirtualNetworkReference
| Name | Description | Value |
|---|---|---|
| id | 托管虚拟网络的 ID。 | 字符串 |
| referenceName | 托管虚拟网络的引用名称 | 字符串 |
| 类型 | 托管虚拟网络的类型。 | 字符串 |
ManagedIntegrationRuntimeTypeProperties
| Name | Description | Value |
|---|---|---|
| computeProperties | 托管集成运行时的计算资源。 | IntegrationRuntimeComputeProperties |
| customerVirtualNetwork | Azure-SSIS 集成运行时要加入的虚拟网络的名称 | IntegrationRuntimeCustomerVirtualNetwork |
| ssisProperties | 托管集成运行时的 SSIS 属性。 | IntegrationRuntimeSsisProperties |
SecretBase
| Name | Description | Value |
|---|---|---|
| 类型 | 对于 类型 SecureString,请设置为“SecureString”。 | 'SecureString'(必需) |
SecureString
| Name | Description | Value |
|---|---|---|
| 类型 | 机密的类型。 | string (必需) |
| value | 安全字符串的值。 | string (必需) |
SecureString
| Name | Description | Value |
|---|---|---|
| 类型 | 机密的类型。 | 'SecureString'(必需) |
| value | 安全字符串的值。 | string (必需) |
SelfHostedIntegrationRuntime
| Name | Description | Value |
|---|---|---|
| 类型 | 集成运行时的类型。 | “自托管”(必需) |
| typeProperties | 如果此属性不为 null,则表示这是链接的集成运行时。 该属性用于访问原始集成运行时。 | SelfHostedIntegrationRuntimeTypeProperties |
SelfHostedIntegrationRuntimeTypeProperties
| Name | Description | Value |
|---|---|---|
| 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
}
}
IntegrationRuntime 对象
设置 type 属性以指定对象的类型。
对于 托管,请使用:
{
"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 对象
设置 type 属性以指定对象的类型。
对于 SecureString,请使用:
{
"type": "SecureString",
"value": "string"
}
CustomSetupBase 对象
设置 type 属性以指定对象的类型。
对于 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"
}
属性值
Microsoft.Synapse/workspaces/integrationRuntimes
| Name | Description | Value |
|---|---|---|
| apiVersion | API 版本 | '2021-06-01' |
| name | 资源名称 | string (必需) |
| properties | 集成运行时属性。 | IntegrationRuntime (必需) |
| 类型 | 资源类型 | 'Microsoft.Synapse/workspaces/integrationRuntimes' |
CmdkeySetup
| Name | Description | Value |
|---|---|---|
| 类型 | 自定义设置的类型。 | “CmdkeySetup”(必需) |
| typeProperties | Cmdkey 命令自定义安装类型属性。 | CmdkeySetupTypeProperties (必需) |
CmdkeySetupTypeProperties
| Name | Description | Value |
|---|---|---|
| 密码 | 数据源访问的密码。 | SecretBase (必需) |
| targetName | 数据源访问的服务器名称。 | 任何(必需) |
| userName | 数据源访问的用户名。 | 任何(必需) |
ComponentSetup
| Name | Description | Value |
|---|---|---|
| 类型 | 自定义设置的类型。 | 'ComponentSetup'(必需) |
| typeProperties | 安装第三方组件类型属性。 | LicensedComponentSetupTypeProperties (必需) |
CustomSetupBase
| Name | Description | Value |
|---|---|---|
| 类型 | 对于 类型 CmdkeySetup,设置为“CmdkeySetup”。 将 类型 ComponentSetup 设置为“ComponentSetup”。 将 EnvironmentVariableSetup 类型设置为“EnvironmentVariableSetup”。 | 'CmdkeySetup' 'ComponentSetup' 'EnvironmentVariableSetup'(必需) |
EntityReference
| Name | Description | Value |
|---|---|---|
| referenceName | 此引用实体的名称。 | 字符串 |
| 类型 | 此引用实体的类型。 | 'IntegrationRuntimeReference' 'LinkedServiceReference' |
EnvironmentVariableSetup
| Name | Description | Value |
|---|---|---|
| 类型 | 自定义设置的类型。 | 'EnvironmentVariableSetup'(必需) |
| typeProperties | 添加环境变量类型属性。 | EnvironmentVariableSetupTypeProperties (必需) |
EnvironmentVariableSetupTypeProperties
| Name | Description | Value |
|---|---|---|
| variableName | 环境变量的名称。 | string (必需) |
| variableValue | 环境变量的值。 | string (必需) |
IntegrationRuntime
| Name | Description | Value |
|---|---|---|
| description | 集成运行时说明。 | 字符串 |
| 类型 | 将类型 ManagedIntegrationRuntime 设置为“托管”。 将 类型 SelfHostedIntegrationRuntime 设置为“SelfHosted”。 | 'Managed' “自托管”(必需) |
IntegrationRuntimeComputeProperties
| Name | Description | Value |
|---|---|---|
| dataFlowProperties | 托管集成运行时的数据流属性。 | IntegrationRuntimeDataFlowProperties |
| 位置 | 托管集成运行时的位置。 可以在 /azure/data-factory/data-factory/data-factory-data-movement-activities 中找到受支持的区域 | 字符串 |
| maxParallelExecutionsPerNode | 托管集成运行时每个节点的最大并行执行计数。 | int Constraints: 最小值 = 1 |
| nodeSize | 托管集成运行时的节点大小要求。 | 字符串 |
| numberOfNodes | 托管集成运行时所需的节点数。 | int Constraints: 最小值 = 1 |
| vNetProperties | 托管集成运行时的 VNet 属性。 | IntegrationRuntimeVNetProperties |
IntegrationRuntimeCustomerVirtualNetwork
| Name | Description | Value |
|---|---|---|
| subnetId | Azure-SSIS 集成运行时要加入的子网的 ID。 | 字符串 |
IntegrationRuntimeCustomSetupScriptProperties
| Name | Description | Value |
|---|---|---|
| blobContainerUri | 包含自定义安装脚本的 Azure Blob 容器的 URI。 | 字符串 |
| sasToken | Azure Blob 容器的 SAS 令牌。 | SecureString |
IntegrationRuntimeDataFlowProperties
| Name | Description | Value |
|---|---|---|
| computeType | 将执行数据流作业的群集的计算类型。 | 'ComputeOptimized' 'General' 'MemoryOptimized' |
| coreCount | 将执行数据流作业的群集的核心计数。 支持的值为:8、16、32、48、80、144 和 272。 | int |
| timeToLive | 将执行数据流作业的群集生存时间(以分钟为单位)。 | int Constraints: 最小值 = 0 |
IntegrationRuntimeDataProxyProperties
| Name | Description | Value |
|---|---|---|
| connectVia | 自承载集成运行时参考。 | EntityReference |
| 路径 | 包含 Blob 存储中暂存数据的路径。 | 字符串 |
| stagingLinkedService | 暂存链接服务引用。 | EntityReference |
IntegrationRuntimeSsisCatalogInfo
| Name | Description | Value |
|---|---|---|
| catalogAdminPassword | 目录数据库的管理员用户帐户的密码。 | SecureString |
| catalogAdminUserName | 目录数据库的管理员用户名。 | string Constraints: 最小长度 = 1 最大长度 = 128 |
| catalogPricingTier | 目录数据库的定价层。 可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效值 | 'Basic' 'Premium' 'PremiumRS' 'Standard' |
| catalogServerEndpoint | 目录数据库服务器 URL。 | 字符串 |
IntegrationRuntimeSsisProperties
| Name | Description | Value |
|---|---|---|
| catalogInfo | 托管专用集成运行时的目录信息。 | IntegrationRuntimeSsisCatalogInfo |
| customSetupScriptProperties | 托管专用集成运行时的自定义设置脚本属性。 | IntegrationRuntimeCustomSetupScriptProperties |
| dataProxyProperties | 托管专用集成运行时的数据代理属性。 | IntegrationRuntimeDataProxyProperties |
| edition | SSIS Integration Runtime 的版本 | 'Enterprise' 'Standard' |
| expressCustomSetupProperties | 没有 SSIS 集成运行时的脚本属性的自定义设置。 | CustomSetupBase[] |
| licenseType | 用于自带许可证方案的许可证类型。 | 'BasePrice' 'LicenseIncluded' |
IntegrationRuntimeVNetProperties
| Name | Description | Value |
|---|---|---|
| publicIPs | 此集成运行时将使用的公共 IP 地址的资源 ID。 | string[] |
| 子网 | 此集成运行时将加入的子网的名称。 | 字符串 |
| subnetId | 要加入此 Azure-SSIS 集成运行时的子网 ID。 | 字符串 |
| vNetId | 此集成运行时将加入的 VNet 的 ID。 | 字符串 |
LicensedComponentSetupTypeProperties
| Name | Description | Value |
|---|---|---|
| componentName | 第三方组件的名称。 | string (必需) |
| licenseKey | 用于激活组件的许可证密钥。 | SecretBase |
LinkedIntegrationRuntimeKeyAuthorization
| Name | Description | Value |
|---|---|---|
| authorizationType | 集成运行时共享的授权类型。 | “键”(必填) |
| 关键值 | 用于授权的密钥。 | SecureString (必需) |
LinkedIntegrationRuntimeRbacAuthorization
| Name | Description | Value |
|---|---|---|
| authorizationType | 集成运行时共享的授权类型。 | 'RBAC'(必需) |
| resourceId | 要共享的集成运行时的资源标识符。 | string (必需) |
LinkedIntegrationRuntimeType
| Name | Description | Value |
|---|---|---|
| authorizationType | 将 LinkedIntegrationRuntimeKeyAuthorization 类型设置为“Key”。 将 LinkedIntegrationRuntimeRbacAuthorization 类型设置为“RBAC”。 | 'Key' 'RBAC'(必需) |
ManagedIntegrationRuntime
| Name | Description | Value |
|---|---|---|
| managedVirtualNetwork | 托管集成运行时托管虚拟网络。 | ManagedIntegrationRuntimeManagedVirtualNetworkReference |
| 类型 | 集成运行时的类型。 | “托管”(必填) |
| typeProperties | 托管集成运行时属性。 | ManagedIntegrationRuntimeTypeProperties (必需) |
ManagedIntegrationRuntimeManagedVirtualNetworkReference
| Name | Description | Value |
|---|---|---|
| id | 托管虚拟网络的 ID。 | 字符串 |
| referenceName | 托管虚拟网络的引用名称 | 字符串 |
| 类型 | 托管虚拟网络的类型。 | 字符串 |
ManagedIntegrationRuntimeTypeProperties
| Name | Description | Value |
|---|---|---|
| computeProperties | 托管集成运行时的计算资源。 | IntegrationRuntimeComputeProperties |
| customerVirtualNetwork | Azure-SSIS 集成运行时要加入的虚拟网络的名称 | IntegrationRuntimeCustomerVirtualNetwork |
| ssisProperties | 托管集成运行时的 SSIS 属性。 | IntegrationRuntimeSsisProperties |
SecretBase
| Name | Description | Value |
|---|---|---|
| 类型 | 对于 类型 SecureString,请设置为“SecureString”。 | 'SecureString'(必需) |
SecureString
| Name | Description | Value |
|---|---|---|
| 类型 | 机密的类型。 | string (必需) |
| value | 安全字符串的值。 | string (必需) |
SecureString
| Name | Description | Value |
|---|---|---|
| 类型 | 机密的类型。 | 'SecureString'(必需) |
| value | 安全字符串的值。 | string (必需) |
SelfHostedIntegrationRuntime
| Name | Description | Value |
|---|---|---|
| 类型 | 集成运行时的类型。 | “自托管”(必需) |
| typeProperties | 如果此属性不为 null,则表示这是链接的集成运行时。 该属性用于访问原始集成运行时。 | SelfHostedIntegrationRuntimeTypeProperties |
SelfHostedIntegrationRuntimeTypeProperties
| Name | Description | Value |
|---|---|---|
| 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"
parent_id = "string"
body = {
properties = {
description = "string"
type = "string"
// For remaining properties, see IntegrationRuntime objects
}
}
}
IntegrationRuntime 对象
设置 type 属性以指定对象的类型。
对于 托管,请使用:
{
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 对象
设置 type 属性以指定对象的类型。
对于 SecureString,请使用:
{
type = "SecureString"
value = "string"
}
CustomSetupBase 对象
设置 type 属性以指定对象的类型。
对于 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"
}
属性值
Microsoft.Synapse/workspaces/integrationRuntimes
| Name | Description | Value |
|---|---|---|
| name | 资源名称 | string (必需) |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID:工作区 |
| properties | 集成运行时属性。 | IntegrationRuntime (必需) |
| 类型 | 资源类型 | "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01" |
CmdkeySetup
| Name | Description | Value |
|---|---|---|
| 类型 | 自定义设置的类型。 | “CmdkeySetup”(必需) |
| typeProperties | Cmdkey 命令自定义安装类型属性。 | CmdkeySetupTypeProperties (必需) |
CmdkeySetupTypeProperties
| Name | Description | Value |
|---|---|---|
| 密码 | 数据源访问的密码。 | SecretBase (必需) |
| targetName | 数据源访问的服务器名称。 | 任何(必需) |
| userName | 数据源访问的用户名。 | 任何(必需) |
ComponentSetup
| Name | Description | Value |
|---|---|---|
| 类型 | 自定义设置的类型。 | 'ComponentSetup'(必需) |
| typeProperties | 安装第三方组件类型属性。 | LicensedComponentSetupTypeProperties (必需) |
CustomSetupBase
| Name | Description | Value |
|---|---|---|
| 类型 | 对于 类型 CmdkeySetup,设置为“CmdkeySetup”。 将 类型 ComponentSetup 设置为“ComponentSetup”。 将 EnvironmentVariableSetup 类型设置为“EnvironmentVariableSetup”。 | 'CmdkeySetup' 'ComponentSetup' 'EnvironmentVariableSetup'(必需) |
EntityReference
| Name | Description | Value |
|---|---|---|
| referenceName | 此引用实体的名称。 | 字符串 |
| 类型 | 此引用实体的类型。 | 'IntegrationRuntimeReference' 'LinkedServiceReference' |
EnvironmentVariableSetup
| Name | Description | Value |
|---|---|---|
| 类型 | 自定义设置的类型。 | 'EnvironmentVariableSetup'(必需) |
| typeProperties | 添加环境变量类型属性。 | EnvironmentVariableSetupTypeProperties (必需) |
EnvironmentVariableSetupTypeProperties
| Name | Description | Value |
|---|---|---|
| variableName | 环境变量的名称。 | string (必需) |
| variableValue | 环境变量的值。 | string (必需) |
IntegrationRuntime
| Name | Description | Value |
|---|---|---|
| description | 集成运行时说明。 | 字符串 |
| 类型 | 将类型 ManagedIntegrationRuntime 设置为“托管”。 将 类型 SelfHostedIntegrationRuntime 设置为“SelfHosted”。 | 'Managed' “自托管”(必需) |
IntegrationRuntimeComputeProperties
| Name | Description | Value |
|---|---|---|
| dataFlowProperties | 托管集成运行时的数据流属性。 | IntegrationRuntimeDataFlowProperties |
| 位置 | 托管集成运行时的位置。 可以在 /azure/data-factory/data-factory/data-factory-data-movement-activities 中找到受支持的区域 | 字符串 |
| maxParallelExecutionsPerNode | 托管集成运行时每个节点的最大并行执行计数。 | int Constraints: 最小值 = 1 |
| nodeSize | 托管集成运行时的节点大小要求。 | 字符串 |
| numberOfNodes | 托管集成运行时所需的节点数。 | int Constraints: 最小值 = 1 |
| vNetProperties | 托管集成运行时的 VNet 属性。 | IntegrationRuntimeVNetProperties |
IntegrationRuntimeCustomerVirtualNetwork
| Name | Description | Value |
|---|---|---|
| subnetId | Azure-SSIS 集成运行时要加入的子网的 ID。 | 字符串 |
IntegrationRuntimeCustomSetupScriptProperties
| Name | Description | Value |
|---|---|---|
| blobContainerUri | 包含自定义安装脚本的 Azure Blob 容器的 URI。 | 字符串 |
| sasToken | Azure Blob 容器的 SAS 令牌。 | SecureString |
IntegrationRuntimeDataFlowProperties
| Name | Description | Value |
|---|---|---|
| computeType | 将执行数据流作业的群集的计算类型。 | 'ComputeOptimized' 'General' 'MemoryOptimized' |
| coreCount | 将执行数据流作业的群集的核心计数。 支持的值为:8、16、32、48、80、144 和 272。 | int |
| timeToLive | 将执行数据流作业的群集生存时间(以分钟为单位)。 | int Constraints: 最小值 = 0 |
IntegrationRuntimeDataProxyProperties
| Name | Description | Value |
|---|---|---|
| connectVia | 自承载集成运行时参考。 | EntityReference |
| 路径 | 包含 Blob 存储中暂存数据的路径。 | 字符串 |
| stagingLinkedService | 暂存链接服务引用。 | EntityReference |
IntegrationRuntimeSsisCatalogInfo
| Name | Description | Value |
|---|---|---|
| catalogAdminPassword | 目录数据库的管理员用户帐户的密码。 | SecureString |
| catalogAdminUserName | 目录数据库的管理员用户名。 | string Constraints: 最小长度 = 1 最大长度 = 128 |
| catalogPricingTier | 目录数据库的定价层。 可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效值 | 'Basic' 'Premium' 'PremiumRS' 'Standard' |
| catalogServerEndpoint | 目录数据库服务器 URL。 | 字符串 |
IntegrationRuntimeSsisProperties
| Name | Description | Value |
|---|---|---|
| catalogInfo | 托管专用集成运行时的目录信息。 | IntegrationRuntimeSsisCatalogInfo |
| customSetupScriptProperties | 托管专用集成运行时的自定义设置脚本属性。 | IntegrationRuntimeCustomSetupScriptProperties |
| dataProxyProperties | 托管专用集成运行时的数据代理属性。 | IntegrationRuntimeDataProxyProperties |
| edition | SSIS Integration Runtime 的版本 | 'Enterprise' 'Standard' |
| expressCustomSetupProperties | 没有 SSIS 集成运行时的脚本属性的自定义设置。 | CustomSetupBase[] |
| licenseType | 用于自带许可证方案的许可证类型。 | 'BasePrice' 'LicenseIncluded' |
IntegrationRuntimeVNetProperties
| Name | Description | Value |
|---|---|---|
| publicIPs | 此集成运行时将使用的公共 IP 地址的资源 ID。 | string[] |
| 子网 | 此集成运行时将加入的子网的名称。 | 字符串 |
| subnetId | 要加入此 Azure-SSIS 集成运行时的子网 ID。 | 字符串 |
| vNetId | 此集成运行时将加入的 VNet 的 ID。 | 字符串 |
LicensedComponentSetupTypeProperties
| Name | Description | Value |
|---|---|---|
| componentName | 第三方组件的名称。 | string (必需) |
| licenseKey | 用于激活组件的许可证密钥。 | SecretBase |
LinkedIntegrationRuntimeKeyAuthorization
| Name | Description | Value |
|---|---|---|
| authorizationType | 集成运行时共享的授权类型。 | “键”(必填) |
| 关键值 | 用于授权的密钥。 | SecureString (必需) |
LinkedIntegrationRuntimeRbacAuthorization
| Name | Description | Value |
|---|---|---|
| authorizationType | 集成运行时共享的授权类型。 | 'RBAC'(必需) |
| resourceId | 要共享的集成运行时的资源标识符。 | string (必需) |
LinkedIntegrationRuntimeType
| Name | Description | Value |
|---|---|---|
| authorizationType | 将 LinkedIntegrationRuntimeKeyAuthorization 类型设置为“Key”。 将 LinkedIntegrationRuntimeRbacAuthorization 类型设置为“RBAC”。 | 'Key' 'RBAC'(必需) |
ManagedIntegrationRuntime
| Name | Description | Value |
|---|---|---|
| managedVirtualNetwork | 托管集成运行时托管虚拟网络。 | ManagedIntegrationRuntimeManagedVirtualNetworkReference |
| 类型 | 集成运行时的类型。 | “托管”(必填) |
| typeProperties | 托管集成运行时属性。 | ManagedIntegrationRuntimeTypeProperties (必需) |
ManagedIntegrationRuntimeManagedVirtualNetworkReference
| Name | Description | Value |
|---|---|---|
| id | 托管虚拟网络的 ID。 | 字符串 |
| referenceName | 托管虚拟网络的引用名称 | 字符串 |
| 类型 | 托管虚拟网络的类型。 | 字符串 |
ManagedIntegrationRuntimeTypeProperties
| Name | Description | Value |
|---|---|---|
| computeProperties | 托管集成运行时的计算资源。 | IntegrationRuntimeComputeProperties |
| customerVirtualNetwork | Azure-SSIS 集成运行时要加入的虚拟网络的名称 | IntegrationRuntimeCustomerVirtualNetwork |
| ssisProperties | 托管集成运行时的 SSIS 属性。 | IntegrationRuntimeSsisProperties |
SecretBase
| Name | Description | Value |
|---|---|---|
| 类型 | 对于 类型 SecureString,请设置为“SecureString”。 | 'SecureString'(必需) |
SecureString
| Name | Description | Value |
|---|---|---|
| 类型 | 机密的类型。 | string (必需) |
| value | 安全字符串的值。 | string (必需) |
SecureString
| Name | Description | Value |
|---|---|---|
| 类型 | 机密的类型。 | 'SecureString'(必需) |
| value | 安全字符串的值。 | string (必需) |
SelfHostedIntegrationRuntime
| Name | Description | Value |
|---|---|---|
| 类型 | 集成运行时的类型。 | “自托管”(必需) |
| typeProperties | 如果此属性不为 null,则表示这是链接的集成运行时。 该属性用于访问原始集成运行时。 | SelfHostedIntegrationRuntimeTypeProperties |
SelfHostedIntegrationRuntimeTypeProperties
| Name | Description | Value |
|---|---|---|
| linkedInfo | 数据工厂中的链接集成运行时类型 | LinkedIntegrationRuntimeType |
用法示例
Terraform 示例
部署 Synapse Azure Integration Runtime 的基本示例。
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
variable "sql_administrator_login" {
type = string
description = "The SQL administrator login for the Synapse workspace"
}
variable "sql_administrator_login_password" {
type = string
description = "The SQL administrator login password for the Synapse workspace"
sensitive = true
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "storageAccount" {
type = "Microsoft.Storage/storageAccounts@2021-09-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
kind = "StorageV2"
properties = {
}
sku = {
name = "Standard_LRS"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
data "azapi_resource_action" "listKeys" {
type = "Microsoft.Storage/storageAccounts@2022-09-01"
resource_id = azapi_resource.storageAccount.id
action = "listKeys"
response_export_values = ["*"]
}
data "azapi_resource" "blobService" {
type = "Microsoft.Storage/storageAccounts/blobServices@2022-09-01"
parent_id = azapi_resource.storageAccount.id
name = "default"
}
resource "azapi_resource" "container" {
type = "Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01"
name = var.resource_name
parent_id = data.azapi_resource.blobService.id
body = {
properties = {
metadata = {
key = "value"
}
}
}
response_export_values = ["*"]
}
resource "azapi_resource" "workspace" {
type = "Microsoft.Synapse/workspaces@2021-06-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
identity {
type = "SystemAssigned"
identity_ids = []
}
body = {
properties = {
defaultDataLakeStorage = {
accountUrl = azapi_resource.storageAccount.output.properties.primaryEndpoints.dfs
filesystem = azapi_resource.container.name
}
managedVirtualNetwork = "default"
publicNetworkAccess = "Enabled"
sqlAdministratorLogin = var.sql_administrator_login
sqlAdministratorLoginPassword = var.sql_administrator_login_password
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "integrationRuntime" {
type = "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01-preview"
parent_id = azapi_resource.workspace.id
name = var.resource_name
body = {
properties = {
description = "test"
type = "SelfHosted"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}