Microsoft.DataFactory Factoryies/integrationRuntimes 2017-09-01-preview

  • 發行項

Bicep 資源定義

Factory/integrationRuntimes 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DataFactory/factories/integrationRuntimes 資源，請將下列 Bicep 新增至範本。

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

IntegrationRuntime 物件

設定 type 屬性以指定物件的類型。

針對 [受控]，請使用：

  type: 'Managed'
  typeProperties: {
    computeProperties: {
      location: 'string'
      maxParallelExecutionsPerNode: int
      nodeSize: 'string'
      numberOfNodes: int
      vNetProperties: {
        subnet: 'string'
        vNetId: 'string'
        {customized property}: any()
      }
      {customized property}: any()
    }
    ssisProperties: {
      catalogInfo: {
        catalogAdminPassword: {
          type: 'string'
          value: 'string'
        }
        catalogAdminUserName: 'string'
        catalogPricingTier: 'string'
        catalogServerEndpoint: 'string'
        {customized property}: any()
      }
      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'
      {customized property}: any()
    }
  }

針對 SelfHosted，請使用：

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

LinkedIntegrationRuntimeProperties 物件

設定 authorizationType 屬性以指定對象的類型。

針對 [金鑰]，請使用：

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

針對 RBAC，請使用：

  authorizationType: 'RBAC'
  resourceId: 'string'

屬性值

factories/integrationRuntimes

名稱 描述 值
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。		 需要字串 ()

字元限制：3-63

合法字元：
英數字元和連字號。

以英數字元開頭及結尾。
父系 (parent) 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增此屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱： Factory
properties 整合運行時間屬性。 IntegrationRuntime (必要)

IntegrationRuntime

名稱 描述 值
description 整合運行時間描述。 字串
type 設定物件類型 受控
需要 SelfHosted ()

ManagedIntegrationRuntime

名稱 描述 值
類型 整合運行時間的類型。 必要) 'Managed' (
typeProperties 受控整合運行時間屬性。 ManagedIntegrationRuntimeTypeProperties (必要)

ManagedIntegrationRuntimeTypeProperties

名稱 描述 值
computeProperties 受控整合運行時間的計算資源。 IntegrationRuntimeComputeProperties
ssisProperties Managed 整合運行時間的 SSIS 屬性。 IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

名稱 描述 值
location 受控整合運行時間的位置。 在 /azure/data-factory/data-factory/data-factory-data-movement-activities 上可以找到支持的區域 字串
maxParallelExecutionsPerNode 受控整合運行時間每個節點的平行執行計數上限。 int

約束：
最小值 = 1
nodeSize 受控整合運行時間的節點大小需求。 字串
numberOfNodes 受控整合運行時間的必要節點數目。 int

約束：
最小值 = 1
vNetProperties 受控整合運行時間的 VNet 屬性。 IntegrationRuntimeVNetProperties
{自定義屬性} 針對 Bicep，您可以使用 任何 () 函式。

IntegrationRuntimeVNetProperties

名稱 描述 值
子網路 此整合運行時間將聯結的子網名稱。 字串
vNetId 此整合運行時間將加入的 VNet 識別碼。 字串
{自定義屬性} 針對 Bicep，您可以使用 任何 () 函式。

IntegrationRuntimeSsisProperties

名稱 描述 值
catalogInfo 受控專用整合運行時間的目錄資訊。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 受控專用整合運行時間的自定義安裝腳本屬性。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 受控專用整合運行時間的數據 Proxy 屬性。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtime 的版本 'Enterprise'
'Standard'
licenseType 攜帶您自己的授權案例的授權類型。 'BasePrice'
'LicenseIncluded'
{自定義屬性} 針對 Bicep，您可以使用 任何 () 函式。

IntegrationRuntimeSsisCatalogInfo

名稱 描述 值
catalogAdminPassword 目錄資料庫的系統管理員用戶帳戶密碼。 SecureString
catalogAdminUserName 目錄資料庫的系統管理員用戶名稱。 字串

約束：
最小長度 = 1
最大長度 = 128
catalogPricingTier 目錄資料庫的定價層。 可以在 中找到有效的值 https://azure.microsoft.com/pricing/details/sql-database/ 字串
catalogServerEndpoint 目錄資料庫伺服器 URL。 字串
{自定義屬性} 針對 Bicep，您可以使用 任何 () 函式。

SecureString

名稱 描述 值
類型 秘密的類型。 字串 (必要)
值 安全字串的值。 字串 (必要)

IntegrationRuntimeCustomSetupScriptProperties

名稱 描述 值
blobContainerUri 包含自訂安裝文本的 Azure Blob 容器 URI。 字串
sasToken Azure Blob 容器的 SAS 令牌。 SecureString

IntegrationRuntimeDataProxyProperties

名稱 描述 值
connectVia 自我裝載整合運行時間參考。 EntityReference
path 要包含 Blob 記憶體中暫存資料的路徑。 字串
stagingLinkedService 預備連結服務參考。 EntityReference

EntityReference

名稱 描述 值
referenceName 這個參考實體的名稱。 字串
type 這個參考實體的類型。 'IntegrationRuntimeReference'
'LinkedServiceReference'

SelfHostedIntegrationRuntime

名稱 描述 值
類型 整合運行時間的類型。 'SelfHosted' (必要)
typeProperties 當這個屬性不是 Null 時，表示這是連結的整合運行時間。 屬性是用來存取原始整合運行時間。 LinkedIntegrationRuntimeTypeProperties (必要)

LinkedIntegrationRuntimeTypeProperties

名稱 描述 值
linkedInfo 秘密類型的基底定義。 LinkedIntegrationRuntimeProperties

LinkedIntegrationRuntimeProperties

名稱 描述 值
authorizationType 設定物件類型 金鑰
需要 RBAC ()

LinkedIntegrationRuntimeKey

名稱 描述 值
authorizationType 秘密的類型。 'Key' (必要)
索引鍵 秘密的類型。 需要 SecureString ()

LinkedIntegrationRuntimeRbac

名稱 描述 值
authorizationType 秘密的類型。 'RBAC' (必要)
resourceId 要共用之整合運行時間的資源標識碼。 需要字串 ()

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
Azure VM 上的自我裝載 Integration Runtime

部署至 Azure		 此範本會建立 selfhost 整合運行時間，並在 Azure 虛擬機上註冊它
使用 Git 和受控 vnet 設定 Azure Data Factory

部署至 Azure		 此範本會使用 Git 組態和受控虛擬網路來建立 Azure Data Factory。
建立 V2 Data Factory (SQL 內部部署)

部署至 Azure		 此範本會建立 V2 數據處理站，將數據從內部部署 SQL Server 複製到 Azure Blob 記憶體
在 Azure 中布建 SSIS 運行時間

部署至 Azure		 此範本會建立 V2 數據處理站，然後布建 Azure SSIS 整合運行時間

ARM 範本資源定義

Factory/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
  }
}

IntegrationRuntime 物件

設定 type 屬性以指定物件的類型。

針對 [受控]，請使用：

  "type": "Managed",
  "typeProperties": {
    "computeProperties": {
      "location": "string",
      "maxParallelExecutionsPerNode": "int",
      "nodeSize": "string",
      "numberOfNodes": "int",
      "vNetProperties": {
        "subnet": "string",
        "vNetId": "string",
        "{customized property}": {}
      },
      "{customized property}": {}
    },
    "ssisProperties": {
      "catalogInfo": {
        "catalogAdminPassword": {
          "type": "string",
          "value": "string"
        },
        "catalogAdminUserName": "string",
        "catalogPricingTier": "string",
        "catalogServerEndpoint": "string",
        "{customized property}": {}
      },
      "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",
      "{customized property}": {}
    }
  }

針對 SelfHosted，請使用：

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

LinkedIntegrationRuntimeProperties 物件

設定 authorizationType 屬性以指定對象的類型。

針對 [金鑰]，請使用：

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

針對 RBAC，請使用：

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

屬性值

factories/integrationRuntimes

名稱 描述 值
類型 資源類型 'Microsoft.DataFactory/factories/integrationRuntimes'
apiVersion 資源 API 版本 '2017-09-01-preview'
NAME 資源名稱

瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。		 需要字串 ()

字元限制：3-63

合法字元：
英數字元和連字號。

以英數字元開頭及結尾。
properties 整合運行時間屬性。 IntegrationRuntime (必要)

IntegrationRuntime

名稱 描述 值
description 整合運行時間描述。 字串
type 設定物件類型 受控
需要 SelfHosted ()

ManagedIntegrationRuntime

名稱 描述 值
類型 整合運行時間的類型。 必要) 'Managed' (
typeProperties 受控整合運行時間屬性。 ManagedIntegrationRuntimeTypeProperties (必要)

ManagedIntegrationRuntimeTypeProperties

名稱 描述 值
computeProperties 受控整合運行時間的計算資源。 IntegrationRuntimeComputeProperties
ssisProperties Managed 整合運行時間的 SSIS 屬性。 IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

名稱 描述 值
location 受控整合運行時間的位置。 在 /azure/data-factory/data-factory/data-factory-data-movement-activities 上可以找到支持的區域 字串
maxParallelExecutionsPerNode 受控整合運行時間每個節點的平行執行計數上限。 int

約束：
最小值 = 1
nodeSize 受控整合運行時間的節點大小需求。 字串
numberOfNodes 受控整合運行時間的必要節點數目。 int

約束：
最小值 = 1
vNetProperties 受控整合運行時間的 VNet 屬性。 IntegrationRuntimeVNetProperties
{自定義屬性}

IntegrationRuntimeVNetProperties

名稱 描述 值
子網路 此整合運行時間將加入的子網名稱。 字串
vNetId 此整合運行時間將加入的 VNet 識別碼。 字串
{自定義屬性}

IntegrationRuntimeSsisProperties

名稱 描述 值
catalogInfo 受控專用整合運行時間的目錄資訊。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 受控專用整合運行時間的自定義安裝腳本屬性。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 受控專用整合運行時間的數據 Proxy 屬性。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtime 的版本 'Enterprise'
'Standard'
licenseType 攜帶您自己的授權案例的授權類型。 'BasePrice'
'LicenseIncluded'
{自定義屬性}

IntegrationRuntimeSsisCatalogInfo

名稱 描述 值
catalogAdminPassword 目錄資料庫的系統管理員用戶帳戶密碼。 SecureString
catalogAdminUserName 目錄資料庫的系統管理員用戶名稱。 字串

約束：
最小長度 = 1
最大長度 = 128
catalogPricingTier 目錄資料庫的定價層。 可以在 中找到有效的值 https://azure.microsoft.com/pricing/details/sql-database/ 字串
catalogServerEndpoint 目錄資料庫伺服器 URL。 字串
{自定義屬性}

SecureString

名稱 描述 值
類型 秘密的類型。 字串 (必要)
值 安全字串的值。 字串 (必要)

IntegrationRuntimeCustomSetupScriptProperties

名稱 描述 值
blobContainerUri 包含自訂安裝文本的 Azure Blob 容器 URI。 字串
sasToken Azure Blob 容器的 SAS 令牌。 SecureString

IntegrationRuntimeDataProxyProperties

名稱 描述 值
connectVia 自我裝載整合運行時間參考。 EntityReference
path 要包含 Blob 記憶體中暫存資料的路徑。 字串
stagingLinkedService 預備連結服務參考。 EntityReference

EntityReference

名稱 描述 值
referenceName 這個參考實體的名稱。 字串
type 這個參考實體的類型。 'IntegrationRuntimeReference'
'LinkedServiceReference'

SelfHostedIntegrationRuntime

名稱 描述 值
類型 整合運行時間的類型。 'SelfHosted' (必要)
typeProperties 當此屬性不是 Null 時，表示這是連結整合運行時間。 屬性是用來存取原始整合運行時間。 LinkedIntegrationRuntimeTypeProperties (必要)

LinkedIntegrationRuntimeTypeProperties

名稱 描述 值
linkedInfo 秘密類型的基底定義。 LinkedIntegrationRuntimeProperties

LinkedIntegrationRuntimeProperties

名稱 描述 值
authorizationType 設定物件類型 金鑰
需要 RBAC ()

LinkedIntegrationRuntimeKey

名稱 描述 值
authorizationType 秘密的類型。 需要 『Key』 ()
索引鍵 秘密的類型。 需要 SecureString ()

LinkedIntegrationRuntimeRbac

名稱 描述 值
authorizationType 秘密的類型。 必要) 『RBAC』 (
resourceId 要共用之整合運行時間的資源標識碼。 字串 (必要)

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
Azure VM 上的自我裝載 Integration Runtime

部署至 Azure		 此範本會建立自我裝載整合運行時間，並在 Azure 虛擬機上註冊它
使用 Git 和受控 vnet 設定 Azure Data Factory

部署至 Azure		 此範本會使用 Git 組態和受控虛擬網路建立 Azure Data Factory。
建立 V2 Data Factory (SQL 內部部署)

部署至 Azure		 此範本會建立 V2 數據處理站，將數據從內部部署 SQL Server 複製到 Azure Blob 記憶體
在 Azure 中布建 SSIS 運行時間

部署至 Azure		 此範本會建立 V2 數據處理站，然後布建 Azure SSIS 整合運行時間

Terraform (AzAPI 提供者) 資源定義

Factory/integrationRuntimes 資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.DataFactory/factories/integrationRuntimes 資源，請將下列 Terraform 新增至您的範本。

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

IntegrationRuntime 物件

設定 type 屬性以指定物件的類型。

針對 Managed，請使用：

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

LinkedIntegrationRuntimeProperties 物件

設定 authorizationType 屬性以指定對象的類型。

針對 金鑰，請使用：

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

針對 RBAC，請使用：

  authorizationType = "RBAC"
  resourceId = "string"

屬性值

factories/integrationRuntimes

名稱 描述 值
類型 資源類型 “Microsoft.DataFactory/factories/integrationRuntimes@2017-09-01-preview”
NAME 資源名稱 字串 (必要)

字元限制：3-63

合法字元：
英數字元和連字號。

以英數字元開頭及結尾。
parent_id 此資源之父系的資源標識碼。 類型資源的標識碼： Factory
properties 整合運行時間屬性。 IntegrationRuntime (必要)

IntegrationRuntime

名稱 描述 值
description 整合運行時間描述。 字串
type 設定物件類型 受控
需要 SelfHosted ()

ManagedIntegrationRuntime

名稱 描述 值
類型 整合運行時間的類型。 「受控」 (必要)
typeProperties 受控整合運行時間屬性。 ManagedIntegrationRuntimeTypeProperties (必要)

ManagedIntegrationRuntimeTypeProperties

名稱 描述 值
computeProperties 受控整合運行時間的計算資源。 IntegrationRuntimeComputeProperties
ssisProperties Managed 整合運行時間的 SSIS 屬性。 IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

名稱 描述 值
location 受控整合運行時間的位置。 在 /azure/data-factory/data-factory/data-factory-data-movement-activities 上可以找到支持的區域 字串
maxParallelExecutionsPerNode 受控整合運行時間的每個節點平行執行計數上限。 int

約束：
最小值 = 1
nodeSize 受控整合運行時間的節點大小需求。 字串
numberOfNodes 受控整合運行時間的必要節點數目。 int

約束：
最小值 = 1
vNetProperties 受控整合運行時間的 VNet 屬性。 IntegrationRuntimeVNetProperties
{自定義屬性}

IntegrationRuntimeVNetProperties

名稱 描述 值
子網路 此整合運行時間將聯結的子網名稱。 字串
vNetId 此整合運行時間將加入的 VNet 識別碼。 字串
{自定義屬性}

IntegrationRuntimeSsisProperties

名稱 描述 值
catalogInfo 受控專用整合運行時間的目錄資訊。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 受控專用整合運行時間的自定義安裝腳本屬性。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 受控專用整合運行時間的數據 Proxy 屬性。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtime 的版本 “企業”
“Standard”
licenseType 攜帶您自己的授權案例的授權類型。 “BasePrice”
“LicenseIncluded”
{自定義屬性}

IntegrationRuntimeSsisCatalogInfo

名稱 描述 值
catalogAdminPassword 目錄資料庫的系統管理員用戶帳戶密碼。 SecureString
catalogAdminUserName 目錄資料庫的系統管理員用戶名稱。 字串

約束：
最小長度 = 1
最大長度 = 128
catalogPricingTier 目錄資料庫的定價層。 可以在 中找到有效的值 https://azure.microsoft.com/pricing/details/sql-database/ 字串
catalogServerEndpoint 目錄資料庫伺服器 URL。 字串
{自定義屬性}

SecureString

名稱 描述 值
類型 秘密的類型。 字串 (必要)
值 安全字串的值。 字串 (必要)

IntegrationRuntimeCustomSetupScriptProperties

名稱 描述 值
blobContainerUri 包含自訂安裝文本的 Azure Blob 容器 URI。 字串
sasToken Azure Blob 容器的 SAS 令牌。 SecureString

IntegrationRuntimeDataProxyProperties

名稱 描述 值
connectVia 自我裝載整合運行時間參考。 EntityReference
path 要包含 Blob 記憶體中暫存資料的路徑。 字串
stagingLinkedService 預備連結服務參考。 EntityReference

EntityReference

名稱 描述 值
referenceName 這個參考實體的名稱。 字串
type 這個參考實體的類型。 “IntegrationRuntimeReference”
“LinkedServiceReference”

SelfHostedIntegrationRuntime

名稱 描述 值
類型 整合運行時間的類型。 “SelfHosted” (必要)
typeProperties 當這個屬性不是 Null 時，表示這是連結的整合運行時間。 屬性是用來存取原始整合運行時間。 LinkedIntegrationRuntimeTypeProperties (必要)

LinkedIntegrationRuntimeTypeProperties

名稱 描述 值
linkedInfo 秘密類型的基底定義。 LinkedIntegrationRuntimeProperties

LinkedIntegrationRuntimeProperties

名稱 描述 值
authorizationType 設定物件類型 金鑰
需要 RBAC ()

LinkedIntegrationRuntimeKey

名稱 描述 值
authorizationType 秘密的類型。 「索引鍵」 (必要)
索引鍵 秘密的類型。 需要 SecureString ()

LinkedIntegrationRuntimeRbac

名稱 描述 值
authorizationType 秘密的類型。 “RBAC” (必要)
resourceId 要共用之整合運行時間的資源標識碼。 需要字串 ()