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

Microsoft.Synapse workspaces/integrationRuntimes

  • 项目

Bicep 资源定义

可以使用面向以下操作部署 workspaces/integrationRuntimes 资源类型：

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

资源格式

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

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

IntegrationRuntime 对象

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

对于 “托管”，请使用：

  type: 'Managed'
  managedVirtualNetwork: {
    id: 'string'
    referenceName: 'string'
    type: 'string'
  }
  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
    }
  }

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'
  }

SecretBase 对象

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

对于 SecureString，请使用：

  type: 'SecureString'
  value: 'string'

LinkedIntegrationRuntimeType 对象

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

对于 “密钥”，请使用：

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

对于 RBAC，请使用：

  authorizationType: 'RBAC'
  resourceId: 'string'

属性值

workspaces/integrationRuntimes

名称 说明 值
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。		 字符串 (必需)
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型为的资源的符号名称： 工作区
properties 集成运行时属性。 IntegrationRuntime (所需的)

IntegrationRuntime

名称 说明 值
description 集成运行时说明。 字符串
type 设置对象类型 托管
SelfHosted (必需)

ManagedIntegrationRuntime

名称 说明 Value
type 集成运行时的类型。 需要“托管” ()
managedVirtualNetwork 托管集成运行时托管虚拟网络。 ManagedIntegrationRuntimeManagedVirtualNetworkRefere...
typeProperties 托管集成运行时属性。 ManagedIntegrationRuntimeTypeProperties (所需的)

ManagedIntegrationRuntimeManagedVirtualNetworkRefere...

名称 说明 Value
id 托管虚拟网络的 ID。 string
referenceName 托管虚拟网络的引用名称 字符串
type 托管虚拟网络的类型。 字符串

ManagedIntegrationRuntimeTypeProperties

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

IntegrationRuntimeComputeProperties

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

IntegrationRuntimeDataFlowProperties

名称 说明 值
computeType 将执行数据流作业的群集的计算类型。 “ComputeOptimized”
“常规”
“MemoryOptimized”
coreCount 将执行数据流作业的群集的核心计数。 支持的值为：8、16、32、48、80、144 和 272。 int
timeToLive 生存时间 (以分钟为单位，) 将执行数据流作业的群集设置。 int

IntegrationRuntimeVNetProperties

名称 说明 值
publicIPs 此集成运行时将使用的公共 IP 地址的资源 ID。 string[]
子网 此集成运行时将加入的子网的名称。 string
subnetId 此 Azure-SSIS 集成运行时将联接到的子网的 ID。 string
vNetId 此集成运行时将加入的 VNet 的 ID。 string

IntegrationRuntimeCustomerVirtualNetwork

名称 说明 值
subnetId Azure-SSIS 集成运行时将加入的子网的 ID。 string

IntegrationRuntimeSsisProperties

名称 说明 值
catalogInfo 托管专用集成运行时的目录信息。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 托管专用集成运行时的自定义安装脚本属性。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 托管专用集成运行时的数据代理属性。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtime的版本 “企业”
'Standard'
expressCustomSetupProperties 不带脚本属性的 SSIS 集成运行时的自定义安装。 CustomSetupBase[]
LicenseType 用于自带许可证方案的许可证类型。 “BasePrice”
“LicenseIncluded”

IntegrationRuntimeSsisCatalogInfo

名称 说明 值
catalogAdminPassword 目录数据库的管理员用户帐户的密码。 SecureString
catalogAdminUserName 目录数据库的管理员用户名。 字符串
catalogPricingTier 目录数据库的定价层。 可以在 中找到有效值 https://azure.microsoft.com/pricing/details/sql-database/ “Basic”
“Premium”
“PremiumRS”
“Standard”
catalogServerEndpoint 目录数据库服务器 URL。 字符串

SecureString

名称 说明 Value
type 机密的类型。 字符串 (必需)
值 安全字符串的值。 字符串 (必需)

IntegrationRuntimeCustomSetupScriptProperties

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

IntegrationRuntimeDataProxyProperties

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

EntityReference

名称 说明 值
referenceName 此引用实体的名称。 字符串
type 此引用实体的类型。 “IntegrationRuntimeReference”
“LinkedServiceReference”

CustomSetupBase

名称 说明 Value
type 设置对象类型 CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (必需)

CmdkeySetup

名称 说明 Value
type 自定义设置的类型。 “CmdkeySetup” (必需)
typeProperties Cmdkey 命令自定义安装类型属性。 cmdkeySetupTypeProperties (必需)

CmdkeySetupTypeProperties

名称 说明 值
password 数据源访问的密码。 需要 secretBase ()
targetName 数据源访问的服务器名称。 对于 Bicep，可以使用所需的 any () function. ()
userName 数据源访问的用户名。 对于 Bicep，可以使用所需的 any () function. ()

SecretBase

名称 说明 Value
type 设置对象类型 需要 SecureString ()

ComponentSetup

名称 说明 Value
type 自定义设置的类型。 “ComponentSetup” (必需)
typeProperties 安装第三方组件类型属性。 LicensedComponentSetupTypeProperties (必需)

LicensedComponentSetupTypeProperties

名称 说明 值
componentName 第三方组件的名称。 字符串 (必需)
LicenseKey 用于激活组件的许可证密钥。 SecretBase

EnvironmentVariableSetup

名称 说明 Value
type 自定义设置的类型。 需要“EnvironmentVariableSetup” ()
typeProperties 添加环境变量类型属性。 EnvironmentVariableSetupTypeProperties (必需的)

EnvironmentVariableSetupTypeProperties

名称 说明 值
variableName 环境变量名。 字符串 (必需)
variableValue 环境变量的值。 字符串 (必需)

SelfHostedIntegrationRuntime

名称 说明 Value
type 集成运行时的类型。 “SelfHosted” (必需)
typeProperties 如果此属性不为 null，则表示这是链接的集成运行时。 属性用于访问原始集成运行时。 SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

名称 说明 值
linkedInfo 数据工厂中的链接集成运行时类型 LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

名称 说明 值
authorizationType 设置对象类型 键
需要 RBAC ()

LinkedIntegrationRuntimeKeyAuthorization

名称 说明 值
authorizationType 集成运行时共享的授权类型。 需要“密钥” ()
key 用于授权的密钥。 需要 SecureString ()

LinkedIntegrationRuntimeRbacAuthorization

名称 说明 值
authorizationType 集成运行时共享的授权类型。 需要“RBAC” ()
ResourceId 要共享的集成运行时的资源标识符。 字符串 (必需)

ARM 模板资源定义

可以使用面向以下操作部署 workspaces/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 属性以指定对象的类型。

对于 “托管”，请使用：

  "type": "Managed",
  "managedVirtualNetwork": {
    "id": "string",
    "referenceName": "string",
    "type": "string"
  },
  "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
    }
  }

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

SecretBase 对象

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

对于 SecureString，请使用：

  "type": "SecureString",
  "value": "string"

LinkedIntegrationRuntimeType 对象

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

对于 “密钥”，请使用：

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

对于 RBAC，请使用：

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

属性值

workspaces/integrationRuntimes

名称 说明 Value
type 资源类型 'Microsoft.Synapse/workspaces/integrationRuntimes'
apiVersion 资源 API 版本 '2021-06-01'
name 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。		 字符串 (必需)
properties 集成运行时属性。 IntegrationRuntime (所需的)

IntegrationRuntime

名称 说明 值
description 集成运行时说明。 字符串
type 设置对象类型 托管
SelfHosted (必需)

ManagedIntegrationRuntime

名称 说明 Value
type 集成运行时的类型。 需要“托管” ()
managedVirtualNetwork 托管集成运行时托管虚拟网络。 ManagedIntegrationRuntimeManagedVirtualNetworkRefere...
typeProperties 托管集成运行时属性。 ManagedIntegrationRuntimeTypeProperties (所需的)

ManagedIntegrationRuntimeManagedVirtualNetworkRefere...

名称 说明 Value
id 托管虚拟网络的 ID。 字符串
referenceName 托管虚拟网络的引用名称 字符串
type 托管虚拟网络的类型。 字符串

ManagedIntegrationRuntimeTypeProperties

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

IntegrationRuntimeComputeProperties

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

IntegrationRuntimeDataFlowProperties

名称 说明 值
computeType 将执行数据流作业的群集的计算类型。 “ComputeOptimized”
“常规”
“MemoryOptimized”
coreCount 将执行数据流作业的群集的核心计数。 支持的值包括：8、16、32、48、80、144 和 272。 int
timeToLive 执行数据流作业的群集) 设置 (生存时间（以分钟为单位）。 int

IntegrationRuntimeVNetProperties

名称 说明 值
publicIPs 此集成运行时将使用的公共 IP 地址的资源 ID。 string[]
子网 此集成运行时将加入的子网的名称。 字符串
subnetId 子网的 ID，此 Azure-SSIS 集成运行时将加入其中。 string
vNetId 此集成运行时将加入的 VNet 的 ID。 字符串

IntegrationRuntimeCustomerVirtualNetwork

名称 说明 值
subnetId Azure-SSIS 集成运行时将加入的子网的 ID。 string

IntegrationRuntimeSsisProperties

名称 说明 值
catalogInfo 托管专用集成运行时的目录信息。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 托管专用集成运行时的自定义安装脚本属性。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 托管专用集成运行时的数据代理属性。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtime的版本 “Enterprise”
“Standard”
expressCustomSetupProperties 不带 SSIS 集成运行时脚本属性的自定义设置。 CustomSetupBase[]
LicenseType 用于自带许可证方案的许可证类型。 “BasePrice”
“LicenseIncluded”

IntegrationRuntimeSsisCatalogInfo

名称 说明 值
catalogAdminPassword 目录数据库的管理员用户帐户的密码。 SecureString
catalogAdminUserName 目录数据库的管理员用户名。 字符串
catalogPricingTier 目录数据库的定价层。 有效值可在 https://azure.microsoft.com/pricing/details/sql-database/ “Basic”
“Premium”
“PremiumRS”
“Standard”
catalogServerEndpoint 目录数据库服务器 URL。 字符串

SecureString

名称 说明 Value
type 机密的类型。 字符串 (必需)
值 安全字符串的值。 字符串 (必需)

IntegrationRuntimeCustomSetupScriptProperties

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

IntegrationRuntimeDataProxyProperties

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

EntityReference

名称 说明 值
referenceName 此引用实体的名称。 字符串
type 此引用实体的类型。 “IntegrationRuntimeReference”
“LinkedServiceReference”

CustomSetupBase

名称 说明 Value
type 设置对象类型 CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (必需)

CmdkeySetup

名称 说明 Value
type 自定义设置的类型。 “CmdkeySetup” (必需)
typeProperties Cmdkey 命令自定义安装类型属性。 CmdkeySetupTypeProperties (必需)

CmdkeySetupTypeProperties

名称 说明 值
password 数据源访问的密码。 需要 secretBase ()
targetName 数据源访问的服务器名称。
userName 数据源访问的用户名。

SecretBase

名称 说明 Value
type 设置对象类型 需要 SecureString ()

ComponentSetup

名称 说明 Value
type 自定义设置的类型。 “ComponentSetup” (必需)
typeProperties 安装第三方组件类型属性。 LicensedComponentSetupTypeProperties (必需)

LicensedComponentSetupTypeProperties

名称 说明 值
componentName 第三方组件的名称。 字符串 (必需)
LicenseKey 用于激活组件的许可证密钥。 SecretBase

EnvironmentVariableSetup

名称 说明 Value
type 自定义设置的类型。 需要“EnvironmentVariableSetup” ()
typeProperties 添加环境变量类型属性。 EnvironmentVariableSetupTypeProperties (必需的)

EnvironmentVariableSetupTypeProperties

名称 说明 值
variableName 环境变量名。 字符串 (必需)
variableValue 环境变量的值。 字符串 (必需)

SelfHostedIntegrationRuntime

名称 说明 Value
type 集成运行时的类型。 “SelfHosted” (必需)
typeProperties 如果此属性不为 null，则表示这是链接的集成运行时。 属性用于访问原始集成运行时。 SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

名称 说明 值
linkedInfo 数据工厂中的链接集成运行时类型 LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

名称 说明 值
authorizationType 设置对象类型 键
需要 RBAC ()

LinkedIntegrationRuntimeKeyAuthorization

名称 说明 值
authorizationType 集成运行时共享的授权类型。 需要“密钥” ()
key 用于授权的密钥。 需要 SecureString ()

LinkedIntegrationRuntimeRbacAuthorization

名称 说明 值
authorizationType 集成运行时共享的授权类型。 需要“RBAC” ()
ResourceId 要共享的集成运行时的资源标识符。 字符串 (必需)

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 workspaces/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 = jsonencode({
    properties = {
      description = "string"
      type = "string"
      // For remaining properties, see IntegrationRuntime objects
    }
  })
}

IntegrationRuntime 对象

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

对于 “托管”，请使用：

  type = "Managed"
  managedVirtualNetwork = {
    id = "string"
    referenceName = "string"
    type = "string"
  }
  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
    }
  }

CustomSetupBase 对象

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

对于 CmdkeySetup，请使用：

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

对于 ComponentSetup，请使用：

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

对于 EnvironmentVariableSetup，请使用：

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

SecretBase 对象

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

对于 SecureString，请使用：

  type = "SecureString"
  value = "string"

LinkedIntegrationRuntimeType 对象

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

对于 “密钥”，请使用：

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

对于 RBAC，请使用：

  authorizationType = "RBAC"
  resourceId = "string"

属性值

workspaces/integrationRuntimes

名称 说明 Value
type 资源类型 “Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型为的资源的 ID： 工作区
properties 集成运行时属性。 IntegrationRuntime (所需的)

IntegrationRuntime

名称 说明 值
description 集成运行时说明。 字符串
type 设置对象类型 托管
SelfHosted (必需)

ManagedIntegrationRuntime

名称 说明 Value
type 集成运行时的类型。 需要“托管” ()
managedVirtualNetwork 托管集成运行时托管虚拟网络。 ManagedIntegrationRuntimeManagedVirtualNetworkRefere...
typeProperties 托管集成运行时属性。 ManagedIntegrationRuntimeTypeProperties (所需的)

ManagedIntegrationRuntimeManagedVirtualNetworkRefere...

名称 说明 Value
id 托管虚拟网络的 ID。 string
referenceName 托管虚拟网络的引用名称 string
type 托管虚拟网络的类型。 字符串

ManagedIntegrationRuntimeTypeProperties

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

IntegrationRuntimeComputeProperties

名称 说明 值
dataFlowProperties 托管集成运行时的数据流属性。 IntegrationRuntimeDataFlowProperties
location 托管集成运行时的位置。 可以在 /azure/data-factory/data-factory/data-factory-data-movement-activities 上找到受支持的区域 string
maxParallelExecutionsPerNode 托管集成运行时的每个节点的最大并行执行计数。 int
nodeSize 托管集成运行时的节点大小要求。 string
numberOfNodes 托管集成运行时所需的节点数。 int
vNetProperties 托管集成运行时的 VNet 属性。 IntegrationRuntimeVNetProperties

IntegrationRuntimeDataFlowProperties

名称 说明 值
computeType 将执行数据流作业的群集的计算类型。 “ComputeOptimized”
“常规”
“MemoryOptimized”
coreCount 将执行数据流作业的群集的核心计数。 支持的值为：8、16、32、48、80、144 和 272。 int
timeToLive 生存时间 (以分钟为单位，) 将执行数据流作业的群集设置。 int

IntegrationRuntimeVNetProperties

名称 说明 值
publicIPs 此集成运行时将使用的公共 IP 地址的资源 ID。 string[]
子网 此集成运行时将加入的子网的名称。 string
subnetId 此 Azure-SSIS 集成运行时将联接到的子网的 ID。 string
vNetId 此集成运行时将加入的 VNet 的 ID。 string

IntegrationRuntimeCustomerVirtualNetwork

名称 说明 值
subnetId Azure-SSIS 集成运行时将加入的子网的 ID。 string

IntegrationRuntimeSsisProperties

名称 说明 值
catalogInfo 托管专用集成运行时的目录信息。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 托管专用集成运行时的自定义安装脚本属性。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 托管专用集成运行时的数据代理属性。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtime的版本 “企业版”
“Standard”
expressCustomSetupProperties 不带 SSIS 集成运行时脚本属性的自定义设置。 CustomSetupBase[]
LicenseType 用于自带许可证方案的许可证类型。 “BasePrice”
“LicenseIncluded”

IntegrationRuntimeSsisCatalogInfo

名称 说明 值
catalogAdminPassword 目录数据库的管理员用户帐户的密码。 SecureString
catalogAdminUserName 目录数据库的管理员用户名。 字符串
catalogPricingTier 目录数据库的定价层。 有效值可在 https://azure.microsoft.com/pricing/details/sql-database/ "Basic"
“Premium”
“PremiumRS”
“Standard”
catalogServerEndpoint 目录数据库服务器 URL。 字符串

SecureString

名称 说明 Value
type 机密的类型。 字符串 (必需)
值 安全字符串的值。 字符串 (必需)

IntegrationRuntimeCustomSetupScriptProperties

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

IntegrationRuntimeDataProxyProperties

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

EntityReference

名称 说明 值
referenceName 此引用实体的名称。 字符串
type 此引用实体的类型。 “IntegrationRuntimeReference”
“LinkedServiceReference”

CustomSetupBase

名称 说明 Value
type 设置对象类型 CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (必需)

CmdkeySetup

名称 说明 Value
type 自定义设置的类型。 “CmdkeySetup” (必需)
typeProperties Cmdkey 命令自定义安装类型属性。 cmdkeySetupTypeProperties (必需)

CmdkeySetupTypeProperties

名称 说明 值
password 数据源访问的密码。 需要 secretBase ()
targetName 数据源访问的服务器名称。
userName 数据源访问的用户名。

SecretBase

名称 说明 Value
type 设置对象类型 需要 SecureString ()

ComponentSetup

名称 说明 Value
type 自定义设置的类型。 “ComponentSetup” (必需)
typeProperties 安装第三方组件类型属性。 LicensedComponentSetupTypeProperties (必需)

LicensedComponentSetupTypeProperties

名称 说明 值
componentName 第三方组件的名称。 字符串 (必需)
LicenseKey 用于激活组件的许可证密钥。 SecretBase

EnvironmentVariableSetup

名称 说明 Value
type 自定义设置的类型。 “EnvironmentVariableSetup” (必需)
typeProperties 添加环境变量类型属性。 EnvironmentVariableSetupTypeProperties (必需)

EnvironmentVariableSetupTypeProperties

名称 说明 值
variableName 环境变量名。 字符串 (必需)
variableValue 环境变量的值。 字符串 (必需)

SelfHostedIntegrationRuntime

名称 说明 Value
type 集成运行时的类型。 “SelfHosted” (必需)
typeProperties 如果此属性不为 null，则表示这是链接的集成运行时。 属性用于访问原始集成运行时。 SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

名称 说明 值
linkedInfo 数据工厂中的链接集成运行时类型 LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

名称 说明 值
authorizationType 设置对象类型 键
需要 RBAC ()

LinkedIntegrationRuntimeKeyAuthorization

名称 说明 值
authorizationType 集成运行时共享的授权类型。 “密钥” (必需)
key 用于授权的密钥。 需要 SecureString ()

LinkedIntegrationRuntimeRbacAuthorization

名称 说明 值
authorizationType 集成运行时共享的授权类型。 “RBAC” (必需的)
ResourceId 要共享的集成运行时的资源标识符。 字符串 (必需)