共用方式為

Microsoft.Synapse 工作區/integrationRuntimes 2019-06-01-preview

  • 發行項

Bicep 資源定義

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

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

資源格式

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

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

IntegrationRuntime 物件

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

針對 [受控]，請使用：

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

名稱 描述 值
類型 整合執行時間的類型。 必要) 'Managed' (
managedVirtualNetwork 受控虛擬網路參考。 ManagedVirtualNetworkReference
typeProperties 受控整合執行時間屬性。 ManagedIntegrationRuntimeTypeProperties (必要)

ManagedVirtualNetworkReference

名稱 描述 值
referenceName 參考 ManagedVirtualNetwork 名稱。 需要字串 ()
類型 Managed 虛擬網路參考類型。 'ManagedVirtualNetworkReference' (必要)

ManagedIntegrationRuntimeTypeProperties

名稱 描述 值
computeProperties 受控整合執行時間的計算資源。 IntegrationRuntimeComputeProperties
ssisProperties Managed 整合執行時間的 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

名稱 描述 值
cleanup 叢集不會回收，而且會在下一個資料流程活動執行期間使用，直到達到 TTL (存留時間) 。如果設定為 false， 預設值為 true。 bool
computeType 將執行資料流程作業之叢集的計算類型。 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount 將執行資料流程作業之叢集的核心計數。 支援的值為：8、16、32、48、80、144 和 272。 int
timeToLive ) 將執行資料流程作業的叢集設定，以分鐘為單位 (存留時間。 int

IntegrationRuntimeVNetProperties

名稱 描述 值
publicIP 此整合執行時間將使用之公用 IP 位址的資源識別碼。 string[]
子網路 此整合執行時間將聯結的子網名稱。 string
vNetId 此整合執行時間將加入的 VNet 識別碼。 string

IntegrationRuntimeSsisProperties

名稱 描述 值
catalogInfo 受控專用整合執行時間的目錄資訊。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 受控專用整合執行時間的自訂安裝腳本屬性。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 受控專用整合執行時間的資料 Proxy 屬性。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtime的版本 'Enterprise'
'Standard'
expressCustomSetupProperties 沒有 SSIS 整合執行時間腳本屬性的自訂安裝。 CustomSetupBase[]
licenseType 攜帶您自己的授權案例的授權類型。 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeSsisCatalogInfo

名稱 描述 值
catalogAdminPassword 目錄資料庫的系統管理員使用者帳戶密碼。 SecureString
catalogAdminUserName 目錄資料庫的系統管理員使用者名稱。 string
catalogPricingTier 目錄資料庫的定價層。 可以在 中找到有效的值 https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint 目錄資料庫伺服器 URL。 string

SecureString

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

IntegrationRuntimeCustomSetupScriptProperties

名稱 描述 值
blobContainerUri 包含自訂安裝腳本的 Azure Blob 容器 URI。 string
sasToken Azure Blob 容器的 SAS 權杖。 SecureString

IntegrationRuntimeDataProxyProperties

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

EntityReference

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

CustomSetupBase

名稱 描述 值
類型 設定物件類型 CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (必要)

CmdkeySetup

名稱 描述 值
類型 自訂設定的類型。 'CmdkeySetup' (必要)
typeProperties Cmdkey 命令自訂安裝類型屬性。 CmdkeySetupTypeProperties (必要)

CmdkeySetupTypeProperties

名稱 描述 值
密碼 資料來源存取的密碼。 SecretBase (必要)
targetName 資料來源存取的伺服器名稱。 針對 Bicep，您可以使用 任何 () function. (必要)
userName 資料來源存取的使用者名稱。 針對 Bicep，您可以使用 任何 () function. (必要)

SecretBase

名稱 描述 值
類型 設定物件類型 需要 SecureString ()

ComponentSetup

名稱 描述 值
類型 自訂設定的類型。 必要 ('ComponentSetup')
typeProperties 安裝協力廠商元件類型屬性。 LicensedComponentSetupTypeProperties (必要)

LicensedComponentSetupTypeProperties

名稱 描述 值
componentName 協力廠商元件的名稱。 字串 (必要)
licenseKey 要啟用元件的授權金鑰。 SecretBase

EnvironmentVariableSetup

名稱 描述 值
類型 自訂設定的類型。 'EnvironmentVariableSetup' (必要)
typeProperties 新增環境變數類型屬性。 EnvironmentVariableSetupTypeProperties (必要)

EnvironmentVariableSetupTypeProperties

名稱 描述 值
variableName 環境變數的名稱。 字串 (必要)
variableValue 環境變數的值。 字串 (必要)

SelfHostedIntegrationRuntime

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

SelfHostedIntegrationRuntimeTypeProperties

名稱 描述 值
linkedInfo 來自資料處理站的連結整合執行時間類型 LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

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

LinkedIntegrationRuntimeKeyAuthorization

名稱 描述 值
authorizationType 整合執行時間共用的授權類型。 需要 'Key' ()
索引鍵 用於授權的金鑰。 需要 SecureString ()

LinkedIntegrationRuntimeRbacAuthorization

名稱 描述 值
authorizationType 整合執行時間共用的授權類型。 必要) 'RBAC' (
resourceId 要共用之整合執行時間的資源識別碼。 字串 (必要)

ARM 範本資源定義

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

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

資源格式

若要建立 Microsoft.Synapse/workspaces/integrationRuntimes 資源，請將下列 JSON 新增至您的範本。

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

IntegrationRuntime 物件

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

針對 Managed，請使用：

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

名稱 描述 值
類型 資源類型 'Microsoft.Synapse/workspaces/integrationRuntimes'
apiVersion 資源 API 版本 '2019-06-01-preview'
NAME 資源名稱

請參閱如何在 JSON ARM 範本中設定子資源的名稱和類型。		 字串 (必要)
properties 整合執行時間屬性。 IntegrationRuntime (必要)

IntegrationRuntime

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

ManagedIntegrationRuntime

名稱 描述 值
類型 整合執行時間的類型。 「受控」 (必要)
managedVirtualNetwork 受控虛擬網路參考。 ManagedVirtualNetworkReference
typeProperties 受控整合執行時間屬性。 ManagedIntegrationRuntimeTypeProperties (必要)

ManagedVirtualNetworkReference

名稱 描述 值
referenceName 參考 ManagedVirtualNetwork 名稱。 字串 (必要)
類型 受控虛擬網路參考類型。 'ManagedVirtualNetworkReference' (必要)

ManagedIntegrationRuntimeTypeProperties

名稱 描述 值
computeProperties 受控整合執行時間的計算資源。 IntegrationRuntimeComputeProperties
ssisProperties Managed 整合執行時間的 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

名稱 描述 值
cleanup 叢集不會回收，而且會在下一個資料流程活動執行期間使用，直到達到 TTL (存留時間) 。如果設定為 false， 預設值為 true。 bool
computeType 將執行資料流程作業之叢集的計算類型。 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount 將執行資料流程作業之叢集的核心計數。 支援的值為：8、16、32、48、80、144 和 272。 int
timeToLive ) 將執行資料流程作業的叢集設定，以分鐘為單位 (存留時間。 int

IntegrationRuntimeVNetProperties

名稱 描述 值
publicIP 此整合執行時間將使用之公用 IP 位址的資源識別碼。 string[]
子網路 此整合執行時間將聯結的子網名稱。 string
vNetId 此整合執行時間將加入的 VNet 識別碼。 string

IntegrationRuntimeSsisProperties

名稱 描述 值
catalogInfo 受控專用整合執行時間的目錄資訊。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 受控專用整合執行時間的自訂安裝腳本屬性。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 受控專用整合執行時間的資料 Proxy 屬性。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtime的版本 'Enterprise'
'Standard'
expressCustomSetupProperties 沒有 SSIS 整合執行時間腳本屬性的自訂安裝。 CustomSetupBase[]
licenseType 攜帶您自己的授權案例的授權類型。 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeSsisCatalogInfo

名稱 描述 值
catalogAdminPassword 目錄資料庫的系統管理員使用者帳戶密碼。 SecureString
catalogAdminUserName 目錄資料庫的系統管理員使用者名稱。 string
catalogPricingTier 目錄資料庫的定價層。 可以在 中找到有效的值 https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint 目錄資料庫伺服器 URL。 string

SecureString

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

IntegrationRuntimeCustomSetupScriptProperties

名稱 描述 值
blobContainerUri 包含自訂安裝腳本的 Azure Blob 容器 URI。 string
sasToken Azure Blob 容器的 SAS 權杖。 SecureString

IntegrationRuntimeDataProxyProperties

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

EntityReference

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

CustomSetupBase

名稱 描述 值
類型 設定物件類型 CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (必要)

CmdkeySetup

名稱 描述 值
類型 自訂設定的類型。 'CmdkeySetup' (必要)
typeProperties Cmdkey 命令自訂安裝類型屬性。 需要 CmdkeySetupTypeProperties ()

CmdkeySetupTypeProperties

名稱 描述 值
密碼 資料來源存取的密碼。 需要 SecretBase ()
targetName 資料來源存取的伺服器名稱。
userName 資料來源存取的使用者名稱。

SecretBase

名稱 描述 值
類型 設定物件類型 需要 SecureString ()

ComponentSetup

名稱 描述 值
類型 自訂設定的類型。 需要 'ComponentSetup' ()
typeProperties 安裝協力廠商元件類型屬性。 LicensedComponentSetupTypeProperties (必要)

LicensedComponentSetupTypeProperties

名稱 描述 值
componentName 協力廠商元件的名稱。 需要字串 ()
licenseKey 要啟動元件的授權金鑰。 SecretBase

EnvironmentVariableSetup

名稱 描述 值
類型 自訂設定的類型。 'EnvironmentVariableSetup' (必要)
typeProperties 新增環境變數類型屬性。 EnvironmentVariableSetupTypeProperties (必要)

EnvironmentVariableSetupTypeProperties

名稱 描述 值
variableName 環境變數的名稱。 需要字串 ()
variableValue 環境變數的值。 需要字串 ()

SelfHostedIntegrationRuntime

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

SelfHostedIntegrationRuntimeTypeProperties

名稱 描述 值
linkedInfo 來自 Data Factory 的連結整合執行時間類型 LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

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

LinkedIntegrationRuntimeKeyAuthorization

名稱 描述 值
authorizationType 整合執行時間共用的授權類型。 需要 'Key' ()
索引鍵 用於授權的金鑰。 需要 SecureString ()

LinkedIntegrationRuntimeRbacAuthorization

名稱 描述 值
authorizationType 整合執行時間共用的授權類型。 必要) 'RBAC' (
resourceId 要共用之整合執行時間的資源識別碼。 字串 (必要)

Terraform (AzAPI 提供者) 資源定義

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

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/integrationRuntimes@2019-06-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"
  managedVirtualNetwork = {
    referenceName = "string"
    type = "ManagedVirtualNetworkReference"
  }
  typeProperties = {
    computeProperties = {
      dataFlowProperties = {
        cleanup = bool
        computeType = "string"
        coreCount = int
        timeToLive = int
      }
      location = "string"
      maxParallelExecutionsPerNode = int
      nodeSize = "string"
      numberOfNodes = int
      vNetProperties = {
        publicIPs = [
          "string"
        ]
        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"
      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

名稱 描述 值
類型 資源類型 「Microsoft.Synapse/workspaces/integrationRuntimes@2019-06-01-preview」
NAME 資源名稱 字串 (必要)
parent_id 此資源之父系的資源識別碼。 類型資源的識別碼： 工作區
properties 整合執行時間屬性。 IntegrationRuntime (必要)

IntegrationRuntime

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

ManagedIntegrationRuntime

名稱 描述 值
類型 整合執行時間的類型。 「受控」 (必要)
managedVirtualNetwork 受控虛擬網路參考。 ManagedVirtualNetworkReference
typeProperties 受控整合執行時間屬性。 ManagedIntegrationRuntimeTypeProperties (必要)

ManagedVirtualNetworkReference

名稱 描述 值
referenceName 參考 ManagedVirtualNetwork 名稱。 字串 (必要)
類型 受控虛擬網路參考類型。 「ManagedVirtualNetworkReference」 (必要)

ManagedIntegrationRuntimeTypeProperties

名稱 描述 值
computeProperties 受控整合執行時間的計算資源。 IntegrationRuntimeComputeProperties
ssisProperties Managed 整合執行時間的 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

名稱 描述 值
cleanup 叢集不會回收，而且會在下一個資料流程活動執行時使用，直到達到 TTL (存留時間) 。 預設值為 true。 bool
computeType 將執行資料流程作業之叢集的計算類型。 「ComputeOptimized」
「一般」
「MemoryOptimized」
coreCount 將執行資料流程作業之叢集的核心計數。 支援的值為：8、16、32、48、80、144 和 272。 int
timeToLive ) 將執行資料流程作業的叢集設定) 分鐘 (存留時間。 int

IntegrationRuntimeVNetProperties

名稱 描述 值
publicIPs 此整合執行時間將使用之公用 IP 位址的資源識別碼。 string[]
子網路 此整合執行時間將加入的子網名稱。 string
vNetId 此整合執行時間將加入的 VNet 識別碼。 string

IntegrationRuntimeSsisProperties

名稱 描述 值
catalogInfo 受控專用整合執行時間的目錄資訊。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 受控專用整合執行時間的自訂安裝腳本屬性。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 受控專用整合執行時間的資料 Proxy 屬性。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtime的版本 「企業」
「標準」
expressCustomSetupProperties 沒有 SSIS 整合執行時間腳本屬性的自訂安裝。 CustomSetupBase[]
licenseType 攜帶您自己的授權案例的授權類型。 「BasePrice」
「LicenseIncluded」

IntegrationRuntimeSsisCatalogInfo

名稱 描述 值
catalogAdminPassword 目錄資料庫的系統管理員使用者帳戶密碼。 SecureString
catalogAdminUserName 目錄資料庫的系統管理員使用者名稱。 string
catalogPricingTier 目錄資料庫的定價層。 可以在 中找到有效的值 https://azure.microsoft.com/pricing/details/sql-database/ "Basic"
「Premium」
「PremiumRS」
「標準」
catalogServerEndpoint 目錄資料庫伺服器 URL。 string

SecureString

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

IntegrationRuntimeCustomSetupScriptProperties

名稱 描述 值
blobContainerUri 包含自訂安裝腳本的 Azure Blob 容器 URI。 string
sasToken Azure Blob 容器的 SAS 權杖。 SecureString

IntegrationRuntimeDataProxyProperties

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

EntityReference

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

CustomSetupBase

名稱 描述 值
類型 設定物件類型 CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (必要)

CmdkeySetup

名稱 描述 值
類型 自訂設定的類型。 「CmdkeySetup」 (必要)
typeProperties Cmdkey 命令自訂安裝類型屬性。 CmdkeySetupTypeProperties (必要)

CmdkeySetupTypeProperties

名稱 描述 值
密碼 資料來源存取的密碼。 SecretBase (必要)
targetName 資料來源存取的伺服器名稱。
userName 資料來源存取的使用者名稱。

SecretBase

名稱 描述 值
類型 設定物件類型 需要 SecureString ()

ComponentSetup

名稱 描述 值
類型 自訂設定的類型。 ) 所需的 「ComponentSetup」 (
typeProperties 安裝協力廠商元件類型屬性。 LicensedComponentSetupTypeProperties (必要)

LicensedComponentSetupTypeProperties

名稱 描述 值
componentName 協力廠商元件的名稱。 字串 (必要)
licenseKey 要啟用元件的授權金鑰。 SecretBase

EnvironmentVariableSetup

名稱 描述 值
類型 自訂設定的類型。 「EnvironmentVariableSetup」 (必要)
typeProperties 新增環境變數類型屬性。 EnvironmentVariableSetupTypeProperties (必要)

EnvironmentVariableSetupTypeProperties

名稱 描述 值
variableName 環境變數的名稱。 需要字串 ()
variableValue 環境變數的值。 需要字串 ()

SelfHostedIntegrationRuntime

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

SelfHostedIntegrationRuntimeTypeProperties

名稱 描述 值
linkedInfo 來自 Data Factory 的連結整合執行時間類型 LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

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

LinkedIntegrationRuntimeKeyAuthorization

名稱 描述 值
authorizationType 整合執行時間共用的授權類型。 「索引鍵」 (必要)
索引鍵 用於授權的金鑰。 需要 SecureString ()

LinkedIntegrationRuntimeRbacAuthorization

名稱 描述 值
authorizationType 整合執行時間共用的授權類型。 「RBAC」 (必要)
resourceId 要共用之整合執行時間的資源識別碼。 需要字串 ()