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

Microsoft.DataFactory 工厂/integrationRuntimes 2017-09-01-preview

Bicep 资源定义

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

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

资源格式

若要创建 Microsoft.DataFactory/factories/integrationRuntimes 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DataFactory/factories/integrationRuntimes@2017-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    type: 'string'
    // For remaining properties, see IntegrationRuntime objects
  }
}

LinkedIntegrationRuntimeProperties 对象

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

对于 密钥,请使用:

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

对于 RBAC,请使用:

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

IntegrationRuntime 对象

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

对于 托管,请使用:

{
  type: 'Managed'
  typeProperties: {
    computeProperties: {
      location: 'string'
      maxParallelExecutionsPerNode: int
      nodeSize: 'string'
      numberOfNodes: int
      vNetProperties: {
        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'
      licenseType: 'string'
    }
  }
}

对于 SelfHosted,请使用:

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

属性值

EntityReference

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

IntegrationRuntime

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

IntegrationRuntimeComputeProperties

名字 描述 价值
位置 托管集成运行时的位置。 可以在 /azure/data-factory/data-factory/data-factory-data-movement-activities 中找到受支持的区域 字符串
maxParallelExecutionsPerNode 托管集成运行时每个节点的最大并行执行计数。 int

约束:
最小值 = 1
nodeSize 托管集成运行时的节点大小要求。 字符串
numberOfNodes 托管集成运行时所需的节点数。 int

约束:
最小值 = 1
vNetProperties 托管集成运行时的 VNet 属性。 IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomSetupScriptProperties

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

IntegrationRuntimeDataProxyProperties

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

IntegrationRuntimeSsisCatalogInfo

名字 描述 价值
catalogAdminPassword 目录数据库的管理员用户帐户的密码。 SecureString
catalogAdminUserName 目录数据库的管理员用户名。 字符串

约束:
最小长度 = 1
最大长度 = 128
catalogPricingTier 目录数据库的定价层。 可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效值 字符串
catalogServerEndpoint 目录数据库服务器 URL。 字符串

IntegrationRuntimeSsisProperties

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

IntegrationRuntimeVNetProperties

名字 描述 价值
此集成运行时将加入的子网的名称。 字符串
vNetId 此集成运行时将加入的 VNet 的 ID。 字符串

LinkedIntegrationRuntimeKey

名字 描述 价值
authorizationType 机密的类型。 “密钥”(必需)
钥匙 机密的类型。 SecureString (必需)

LinkedIntegrationRuntimeProperties

名字 描述 价值
authorizationType 对于 LinkedIntegrationRuntimeKey类型,设置为“键”。 对于 LinkedIntegrationRuntimeRbac类型,设置为“RBAC”。 “Key”
“RBAC”(必需)

LinkedIntegrationRuntimeRbac

名字 描述 价值
authorizationType 机密的类型。 “RBAC”(必需)
resourceId 要共享的集成运行时的资源 ID。 string (必需)

LinkedIntegrationRuntimeTypeProperties

名字 描述 价值
linkedInfo 机密类型的基定义。 LinkedIntegrationRuntimeProperties

ManagedIntegrationRuntime

名字 描述 价值
类型 集成运行时的类型。 “Managed”(必需)
typeProperties 托管集成运行时属性。 ManagedIntegrationRuntimeTypeProperties(必需)

ManagedIntegrationRuntimeTypeProperties

名字 描述 价值
computeProperties 托管集成运行时的计算资源。 IntegrationRuntimeComputeProperties
ssisProperties 托管集成运行时的 SSIS 属性。 IntegrationRuntimeSsisProperties

Microsoft.DataFactory/factories/integrationRuntimes

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 63
模式 = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:工厂
性能 集成运行时属性。 IntegrationRuntime (必需)

SecureString

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

SelfHostedIntegrationRuntime

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

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
使用 Git 和托管 vnet 配置 Azure 数据工厂 此模板使用 Git 配置和托管虚拟网络创建 Azure 数据工厂。
Azure VM 上的自承载集成运行时 此模板创建自承载集成运行时并在 Azure 虚拟机上注册它

ARM 模板资源定义

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

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

资源格式

若要创建 Microsoft.DataFactory/factories/integrationRuntimes 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DataFactory/factories/integrationRuntimes",
  "apiVersion": "2017-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "type": "string"
    // For remaining properties, see IntegrationRuntime objects
  }
}

LinkedIntegrationRuntimeProperties 对象

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

对于 密钥,请使用:

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

对于 RBAC,请使用:

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

IntegrationRuntime 对象

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

对于 托管,请使用:

{
  "type": "Managed",
  "typeProperties": {
    "computeProperties": {
      "location": "string",
      "maxParallelExecutionsPerNode": "int",
      "nodeSize": "string",
      "numberOfNodes": "int",
      "vNetProperties": {
        "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",
      "licenseType": "string"
    }
  }
}

对于 SelfHosted,请使用:

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

属性值

EntityReference

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

IntegrationRuntime

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

IntegrationRuntimeComputeProperties

名字 描述 价值
位置 托管集成运行时的位置。 可以在 /azure/data-factory/data-factory/data-factory-data-movement-activities 中找到受支持的区域 字符串
maxParallelExecutionsPerNode 托管集成运行时每个节点的最大并行执行计数。 int

约束:
最小值 = 1
nodeSize 托管集成运行时的节点大小要求。 字符串
numberOfNodes 托管集成运行时所需的节点数。 int

约束:
最小值 = 1
vNetProperties 托管集成运行时的 VNet 属性。 IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomSetupScriptProperties

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

IntegrationRuntimeDataProxyProperties

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

IntegrationRuntimeSsisCatalogInfo

名字 描述 价值
catalogAdminPassword 目录数据库的管理员用户帐户的密码。 SecureString
catalogAdminUserName 目录数据库的管理员用户名。 字符串

约束:
最小长度 = 1
最大长度 = 128
catalogPricingTier 目录数据库的定价层。 可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效值 字符串
catalogServerEndpoint 目录数据库服务器 URL。 字符串

IntegrationRuntimeSsisProperties

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

IntegrationRuntimeVNetProperties

名字 描述 价值
此集成运行时将加入的子网的名称。 字符串
vNetId 此集成运行时将加入的 VNet 的 ID。 字符串

LinkedIntegrationRuntimeKey

名字 描述 价值
authorizationType 机密的类型。 “密钥”(必需)
钥匙 机密的类型。 SecureString (必需)

LinkedIntegrationRuntimeProperties

名字 描述 价值
authorizationType 对于 LinkedIntegrationRuntimeKey类型,设置为“键”。 对于 LinkedIntegrationRuntimeRbac类型,设置为“RBAC”。 “Key”
“RBAC”(必需)

LinkedIntegrationRuntimeRbac

名字 描述 价值
authorizationType 机密的类型。 “RBAC”(必需)
resourceId 要共享的集成运行时的资源 ID。 string (必需)

LinkedIntegrationRuntimeTypeProperties

名字 描述 价值
linkedInfo 机密类型的基定义。 LinkedIntegrationRuntimeProperties

ManagedIntegrationRuntime

名字 描述 价值
类型 集成运行时的类型。 “Managed”(必需)
typeProperties 托管集成运行时属性。 ManagedIntegrationRuntimeTypeProperties(必需)

ManagedIntegrationRuntimeTypeProperties

名字 描述 价值
computeProperties 托管集成运行时的计算资源。 IntegrationRuntimeComputeProperties
ssisProperties 托管集成运行时的 SSIS 属性。 IntegrationRuntimeSsisProperties

Microsoft.DataFactory/factories/integrationRuntimes

名字 描述 价值
apiVersion API 版本 '2017-09-01-preview'
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 63
模式 = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (必需)
性能 集成运行时属性。 IntegrationRuntime (必需)
类型 资源类型 “Microsoft.DataFactory/factories/integrationRuntimes”

SecureString

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

SelfHostedIntegrationRuntime

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

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
使用 Git 和托管 vnet 配置 Azure 数据工厂

部署到 Azure
此模板使用 Git 配置和托管虚拟网络创建 Azure 数据工厂。
Azure VM 上的自承载集成运行时

部署到 Azure
此模板创建自承载集成运行时并在 Azure 虚拟机上注册它

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

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

  • 资源组

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

资源格式

若要创建 Microsoft.DataFactory/factories/integrationRuntimes 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/integrationRuntimes@2017-09-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      type = "string"
      // For remaining properties, see IntegrationRuntime objects
    }
  })
}

LinkedIntegrationRuntimeProperties 对象

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

对于 密钥,请使用:

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

对于 RBAC,请使用:

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

IntegrationRuntime 对象

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

对于 托管,请使用:

{
  type = "Managed"
  typeProperties = {
    computeProperties = {
      location = "string"
      maxParallelExecutionsPerNode = int
      nodeSize = "string"
      numberOfNodes = int
      vNetProperties = {
        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"
      licenseType = "string"
    }
  }
}

对于 SelfHosted,请使用:

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

属性值

EntityReference

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

IntegrationRuntime

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

IntegrationRuntimeComputeProperties

名字 描述 价值
位置 托管集成运行时的位置。 可以在 /azure/data-factory/data-factory/data-factory-data-movement-activities 中找到受支持的区域 字符串
maxParallelExecutionsPerNode 托管集成运行时每个节点的最大并行执行计数。 int

约束:
最小值 = 1
nodeSize 托管集成运行时的节点大小要求。 字符串
numberOfNodes 托管集成运行时所需的节点数。 int

约束:
最小值 = 1
vNetProperties 托管集成运行时的 VNet 属性。 IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomSetupScriptProperties

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

IntegrationRuntimeDataProxyProperties

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

IntegrationRuntimeSsisCatalogInfo

名字 描述 价值
catalogAdminPassword 目录数据库的管理员用户帐户的密码。 SecureString
catalogAdminUserName 目录数据库的管理员用户名。 字符串

约束:
最小长度 = 1
最大长度 = 128
catalogPricingTier 目录数据库的定价层。 可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效值 字符串
catalogServerEndpoint 目录数据库服务器 URL。 字符串

IntegrationRuntimeSsisProperties

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

IntegrationRuntimeVNetProperties

名字 描述 价值
此集成运行时将加入的子网的名称。 字符串
vNetId 此集成运行时将加入的 VNet 的 ID。 字符串

LinkedIntegrationRuntimeKey

名字 描述 价值
authorizationType 机密的类型。 “密钥”(必需)
钥匙 机密的类型。 SecureString (必需)

LinkedIntegrationRuntimeProperties

名字 描述 价值
authorizationType 对于 LinkedIntegrationRuntimeKey类型,设置为“键”。 对于 LinkedIntegrationRuntimeRbac类型,设置为“RBAC”。 “Key”
“RBAC”(必需)

LinkedIntegrationRuntimeRbac

名字 描述 价值
authorizationType 机密的类型。 “RBAC”(必需)
resourceId 要共享的集成运行时的资源 ID。 string (必需)

LinkedIntegrationRuntimeTypeProperties

名字 描述 价值
linkedInfo 机密类型的基定义。 LinkedIntegrationRuntimeProperties

ManagedIntegrationRuntime

名字 描述 价值
类型 集成运行时的类型。 “Managed”(必需)
typeProperties 托管集成运行时属性。 ManagedIntegrationRuntimeTypeProperties(必需)

ManagedIntegrationRuntimeTypeProperties

名字 描述 价值
computeProperties 托管集成运行时的计算资源。 IntegrationRuntimeComputeProperties
ssisProperties 托管集成运行时的 SSIS 属性。 IntegrationRuntimeSsisProperties

Microsoft.DataFactory/factories/integrationRuntimes

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 63
模式 = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:工厂
性能 集成运行时属性。 IntegrationRuntime (必需)
类型 资源类型 “Microsoft.DataFactory/factories/integrationRuntimes@2017-09-01-preview”

SecureString

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

SelfHostedIntegrationRuntime

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