Microsoft.Synapse 工作區/integrationRuntimes
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 物件
設定 類型 屬性，以指定物件的類型。
針對 Managed，請使用：
{
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 物件
設定 類型 屬性，以指定物件的類型。
針對 SecureString，請使用：
{
type: 'SecureString'
value: 'string'
}
LinkedIntegrationRuntimeType 物件
設定 authorizationType 屬性，以指定對象的類型。
針對 金鑰，請使用：
{
authorizationType: 'Key'
key: {
type: 'string'
value: 'string'
}
}
針對 RBAC，請使用：
{
authorizationType: 'RBAC'
resourceId: 'string'
}
CustomSetupBase 物件
設定 類型 屬性，以指定物件的類型。
針對 CmdkeySetup，請使用：
{
type: 'CmdkeySetup'
typeProperties: {
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
targetName: any(Azure.Bicep.Types.Concrete.AnyType)
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
針對 ComponentSetup，請使用：
{
type: 'ComponentSetup'
typeProperties: {
componentName: 'string'
licenseKey: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
}
針對 EnvironmentVariableSetup，請使用：
{
type: 'EnvironmentVariableSetup'
typeProperties: {
variableName: 'string'
variableValue: 'string'
}
}
屬性值
CmdkeySetup
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 自訂設定的類型。 | 'CmdkeySetup' （必要） |
| typeProperties | Cmdkey 命令自定義安裝類型屬性。 | CmdkeySetupTypeProperties （必要） |
CmdkeySetupTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 密碼 | 數據源存取的密碼。 | SecretBase （必要） |
| targetName | 數據來源取的伺服器名稱。 | 任何 （必要） |
| userName | 數據來源取的用戶名稱。 | 任何 （必要） |
ComponentSetup
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 自訂設定的類型。 | 'ComponentSetup' （必要） |
| typeProperties | 安裝第三方元件類型屬性。 | LicensedComponentSetupTypeProperties （必要） |
CustomSetupBase
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 針對 cmdkeySetup 類型設定為 『CmdkeySetup』，。 將 類型設定為 'ComponentSetup' ComponentSetup。 針對 environmentVariableSetup 類型設定為 'EnvironmentVariableSetup' 。 | 'CmdkeySetup' 'ComponentSetup' 'EnvironmentVariableSetup' （必要） |
EntityReference
| 名字 | 描述 | 價值 |
|---|---|---|
| referenceName | 這個參考實體的名稱。 | 字串 |
| 類型 | 這個參考實體的類型。 | 'IntegrationRuntimeReference' 'LinkedServiceReference' |
EnvironmentVariableSetup
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 自訂設定的類型。 | 'EnvironmentVariableSetup' （必要） |
| typeProperties | 新增環境變數類型屬性。 | EnvironmentVariableSetupTypeProperties （必要） |
EnvironmentVariableSetupTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| variableName | 環境變數的名稱。 | 字串 （必要） |
| variableValue | 環境變數的值。 | 字串 （必要） |
IntegrationRuntime
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 整合運行時間描述。 | 字串 |
| 類型 | 針對 managedIntegrationRuntime 類型 設定為 'Managed'，。 針對 selfHostedIntegrationRuntime 類型設定為 'SelfHosted'，。 | 'Managed' 'SelfHosted' （必要） |
IntegrationRuntimeComputeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| dataFlowProperties | 受控整合運行時間的數據流屬性。 | IntegrationRuntimeDataFlowProperties |
| 位置 | 受控整合運行時間的位置。 在 /azure/data-factory/data-factory/data-factory-data-movement-activities 上可以找到支持的區域 | 字串 |
| maxParallelExecutionsPerNode | 受控整合運行時間每個節點的平行執行計數上限。 | int 約束： 最小值 = 1 |
| nodeSize | 受控整合運行時間的節點大小需求。 | 字串 |
| numberOfNodes | 受控整合運行時間所需的節點數目。 | int 約束： 最小值 = 1 |
| vNetProperties | 受控整合運行時間的 VNet 屬性。 | IntegrationRuntimeVNetProperties |
IntegrationRuntimeCustomerVirtualNetwork
| 名字 | 描述 | 價值 |
|---|---|---|
| subnetId | Azure-SSIS 整合運行時間要加入的子網標識碼。 | 字串 |
IntegrationRuntimeCustomSetupScriptProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| blobContainerUri | 包含自訂安裝文本的 Azure Blob 容器 URI。 | 字串 |
| sasToken | Azure Blob 容器的 SAS 令牌。 | SecureString |
IntegrationRuntimeDataFlowProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| computeType | 將執行數據流作業之叢集的計算類型。 | 'ComputeOptimized' 'General' 'MemoryOptimized' |
| coreCount | 將執行數據流作業之叢集的核心計數。 支援的值為：8、16、32、48、80、144 和 272。 | int |
| timeToLive | 將執行數據流作業的叢集存留時間（以分鐘為單位） 設定。 | int 約束： 最小值 = 0 |
IntegrationRuntimeDataProxyProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| connectVia | 自我裝載整合運行時間參考。 | EntityReference |
| 路徑 | 包含 Blob 記憶體中暫存資料的路徑。 | 字串 |
| stagingLinkedService | 暫存連結服務參考。 | EntityReference |
IntegrationRuntimeSsisCatalogInfo
| 名字 | 描述 | 價值 |
|---|---|---|
| catalogAdminPassword | 目錄資料庫的系統管理員用戶帳戶密碼。 | SecureString |
| catalogAdminUserName | 目錄資料庫的系統管理員用戶名稱。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| catalogPricingTier | 目錄資料庫的定價層。 可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效的值 | 'Basic' 'Premium' 'PremiumRS' 'Standard' |
| catalogServerEndpoint | 目錄資料庫伺服器 URL。 | 字串 |
IntegrationRuntimeSsisProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| catalogInfo | 受控專用整合運行時間的目錄資訊。 | IntegrationRuntimeSsisCatalogInfo |
| customSetupScriptProperties | 受控專用整合運行時間的自定義安裝腳本屬性。 | IntegrationRuntimeCustomSetupScriptProperties |
| dataProxyProperties | 受控專用整合運行時間的數據 Proxy 屬性。 | IntegrationRuntimeDataProxyProperties |
| 版 | SSIS Integration Runtime 的版本 | 'Enterprise' 'Standard' |
| expressCustomSetupProperties | 沒有 SSIS 整合運行時間文本屬性的自訂設定。 | CustomSetupBase[] |
| licenseType | 攜帶您自己的授權案例的授權類型。 | 'BasePrice' 'LicenseIncluded' |
IntegrationRuntimeVNetProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| publicIPs | 此整合運行時間將使用之公用IP位址的資源識別碼。 | string[] |
| 子 | 此整合運行時間將加入的子網名稱。 | 字串 |
| subnetId | 要加入此 Azure-SSIS 整合運行時間的子網標識碼。 | 字串 |
| vNetId | 此整合運行時間將加入之 VNet 的識別碼。 | 字串 |
LicensedComponentSetupTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| componentName | 第三方元件的名稱。 | 字串 （必要） |
| licenseKey | 要啟用元件的授權金鑰。 | SecretBase |
LinkedIntegrationRuntimeKeyAuthorization
| 名字 | 描述 | 價值 |
|---|---|---|
| authorizationType | 整合運行時間共享的授權類型。 | 'Key' （必要） |
| 鑰匙 | 用於授權的金鑰。 | SecureString （必要） |
LinkedIntegrationRuntimeRbacAuthorization
| 名字 | 描述 | 價值 |
|---|---|---|
| authorizationType | 整合運行時間共享的授權類型。 | 'RBAC' （必要） |
| resourceId | 要共用之整合運行時間的資源標識碼。 | 字串 （必要） |
LinkedIntegrationRuntimeType
| 名字 | 描述 | 價值 |
|---|---|---|
| authorizationType | 針對 linkedIntegrationRuntimeKeyAuthorization 類型設定為 'Key'，。 針對 linkedIntegrationRuntimeRbacAuthorization 類型設定為 'RBAC'，。 | 'Key' 'RBAC' （必要） |
ManagedIntegrationRuntime
| 名字 | 描述 | 價值 |
|---|---|---|
| managedVirtualNetwork | 受控整合運行時間受控虛擬網路。 | ManagedIntegrationRuntimeManagedVirtualNetworkReference |
| 類型 | 整合運行時間的類型。 | 'Managed' （必要） |
| typeProperties | 受控整合運行時間屬性。 | ManagedIntegrationRuntimeTypeProperties （必要） |
ManagedIntegrationRuntimeManagedVirtualNetworkReference
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 受控虛擬網路的標識碼。 | 字串 |
| referenceName | 受控虛擬網路的參考名稱 | 字串 |
| 類型 | 受控虛擬網路的類型。 | 字串 |
ManagedIntegrationRuntimeTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| computeProperties | 受控整合運行時間的計算資源。 | IntegrationRuntimeComputeProperties |
| customerVirtualNetwork | Azure-SSIS 整合運行時間將加入的虛擬網路名稱 | IntegrationRuntimeCustomerVirtualNetwork |
| ssisProperties | 受控整合運行時間的 SSIS 屬性。 | IntegrationRuntimeSsisProperties |
Microsoft.Synapse/workspaces/integrationRuntimes
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 （必要） |
| 父母 | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型的資源符號名稱：工作區 |
| 性能 | 整合運行時間屬性。 | IntegrationRuntime （必要） |
SecretBase
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 將 類型設定為 'SecureString'，SecureString。 | 'SecureString' （必要） |
SecureString
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 秘密的類型。 | 字串 （必要） |
| 價值 | 安全字串的值。 | 字串 （必要） |
SecureString
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 秘密的類型。 | 'SecureString' （必要） |
| 價值 | 安全字串的值。 | 字串 （必要） |
SelfHostedIntegrationRuntime
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 整合運行時間的類型。 | 'SelfHosted' （必要） |
| typeProperties | 當這個屬性不是 Null 時，表示這是連結的整合運行時間。 屬性是用來存取原始整合運行時間。 | SelfHostedIntegrationRuntimeTypeProperties |
SelfHostedIntegrationRuntimeTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| linkedInfo | Data Factory 的連結整合運行時間類型 | 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 物件
設定 類型 屬性，以指定物件的類型。
針對 Managed，請使用：
{
"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 物件
設定 類型 屬性，以指定物件的類型。
針對 SecureString，請使用：
{
"type": "SecureString",
"value": "string"
}
LinkedIntegrationRuntimeType 物件
設定 authorizationType 屬性，以指定對象的類型。
針對 金鑰，請使用：
{
"authorizationType": "Key",
"key": {
"type": "string",
"value": "string"
}
}
針對 RBAC，請使用：
{
"authorizationType": "RBAC",
"resourceId": "string"
}
CustomSetupBase 物件
設定 類型 屬性，以指定物件的類型。
針對 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"
}
}
屬性值
CmdkeySetup
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 自訂設定的類型。 | 'CmdkeySetup' （必要） |
| typeProperties | Cmdkey 命令自定義安裝類型屬性。 | CmdkeySetupTypeProperties （必要） |
CmdkeySetupTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 密碼 | 數據源存取的密碼。 | SecretBase （必要） |
| targetName | 數據來源取的伺服器名稱。 | 任何 （必要） |
| userName | 數據來源取的用戶名稱。 | 任何 （必要） |
ComponentSetup
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 自訂設定的類型。 | 'ComponentSetup' （必要） |
| typeProperties | 安裝第三方元件類型屬性。 | LicensedComponentSetupTypeProperties （必要） |
CustomSetupBase
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 針對 cmdkeySetup 類型設定為 『CmdkeySetup』，。 將 類型設定為 'ComponentSetup' ComponentSetup。 針對 environmentVariableSetup 類型設定為 'EnvironmentVariableSetup' 。 | 'CmdkeySetup' 'ComponentSetup' 'EnvironmentVariableSetup' （必要） |
EntityReference
| 名字 | 描述 | 價值 |
|---|---|---|
| referenceName | 這個參考實體的名稱。 | 字串 |
| 類型 | 這個參考實體的類型。 | 'IntegrationRuntimeReference' 'LinkedServiceReference' |
EnvironmentVariableSetup
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 自訂設定的類型。 | 'EnvironmentVariableSetup' （必要） |
| typeProperties | 新增環境變數類型屬性。 | EnvironmentVariableSetupTypeProperties （必要） |
EnvironmentVariableSetupTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| variableName | 環境變數的名稱。 | 字串 （必要） |
| variableValue | 環境變數的值。 | 字串 （必要） |
IntegrationRuntime
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 整合運行時間描述。 | 字串 |
| 類型 | 針對 managedIntegrationRuntime 類型 設定為 'Managed'，。 針對 selfHostedIntegrationRuntime 類型設定為 'SelfHosted'，。 | 'Managed' 'SelfHosted' （必要） |
IntegrationRuntimeComputeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| dataFlowProperties | 受控整合運行時間的數據流屬性。 | IntegrationRuntimeDataFlowProperties |
| 位置 | 受控整合運行時間的位置。 在 /azure/data-factory/data-factory/data-factory-data-movement-activities 上可以找到支持的區域 | 字串 |
| maxParallelExecutionsPerNode | 受控整合運行時間每個節點的平行執行計數上限。 | int 約束： 最小值 = 1 |
| nodeSize | 受控整合運行時間的節點大小需求。 | 字串 |
| numberOfNodes | 受控整合運行時間所需的節點數目。 | int 約束： 最小值 = 1 |
| vNetProperties | 受控整合運行時間的 VNet 屬性。 | IntegrationRuntimeVNetProperties |
IntegrationRuntimeCustomerVirtualNetwork
| 名字 | 描述 | 價值 |
|---|---|---|
| subnetId | Azure-SSIS 整合運行時間要加入的子網標識碼。 | 字串 |
IntegrationRuntimeCustomSetupScriptProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| blobContainerUri | 包含自訂安裝文本的 Azure Blob 容器 URI。 | 字串 |
| sasToken | Azure Blob 容器的 SAS 令牌。 | SecureString |
IntegrationRuntimeDataFlowProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| computeType | 將執行數據流作業之叢集的計算類型。 | 'ComputeOptimized' 'General' 'MemoryOptimized' |
| coreCount | 將執行數據流作業之叢集的核心計數。 支援的值為：8、16、32、48、80、144 和 272。 | int |
| timeToLive | 將執行數據流作業的叢集存留時間（以分鐘為單位） 設定。 | int 約束： 最小值 = 0 |
IntegrationRuntimeDataProxyProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| connectVia | 自我裝載整合運行時間參考。 | EntityReference |
| 路徑 | 包含 Blob 記憶體中暫存資料的路徑。 | 字串 |
| stagingLinkedService | 暫存連結服務參考。 | EntityReference |
IntegrationRuntimeSsisCatalogInfo
| 名字 | 描述 | 價值 |
|---|---|---|
| catalogAdminPassword | 目錄資料庫的系統管理員用戶帳戶密碼。 | SecureString |
| catalogAdminUserName | 目錄資料庫的系統管理員用戶名稱。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| catalogPricingTier | 目錄資料庫的定價層。 可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效的值 | 'Basic' 'Premium' 'PremiumRS' 'Standard' |
| catalogServerEndpoint | 目錄資料庫伺服器 URL。 | 字串 |
IntegrationRuntimeSsisProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| catalogInfo | 受控專用整合運行時間的目錄資訊。 | IntegrationRuntimeSsisCatalogInfo |
| customSetupScriptProperties | 受控專用整合運行時間的自定義安裝腳本屬性。 | IntegrationRuntimeCustomSetupScriptProperties |
| dataProxyProperties | 受控專用整合運行時間的數據 Proxy 屬性。 | IntegrationRuntimeDataProxyProperties |
| 版 | SSIS Integration Runtime 的版本 | 'Enterprise' 'Standard' |
| expressCustomSetupProperties | 沒有 SSIS 整合運行時間文本屬性的自訂設定。 | CustomSetupBase[] |
| licenseType | 攜帶您自己的授權案例的授權類型。 | 'BasePrice' 'LicenseIncluded' |
IntegrationRuntimeVNetProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| publicIPs | 此整合運行時間將使用之公用IP位址的資源識別碼。 | string[] |
| 子 | 此整合運行時間將加入的子網名稱。 | 字串 |
| subnetId | 要加入此 Azure-SSIS 整合運行時間的子網標識碼。 | 字串 |
| vNetId | 此整合運行時間將加入之 VNet 的識別碼。 | 字串 |
LicensedComponentSetupTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| componentName | 第三方元件的名稱。 | 字串 （必要） |
| licenseKey | 要啟用元件的授權金鑰。 | SecretBase |
LinkedIntegrationRuntimeKeyAuthorization
| 名字 | 描述 | 價值 |
|---|---|---|
| authorizationType | 整合運行時間共享的授權類型。 | 'Key' （必要） |
| 鑰匙 | 用於授權的金鑰。 | SecureString （必要） |
LinkedIntegrationRuntimeRbacAuthorization
| 名字 | 描述 | 價值 |
|---|---|---|
| authorizationType | 整合運行時間共享的授權類型。 | 'RBAC' （必要） |
| resourceId | 要共用之整合運行時間的資源標識碼。 | 字串 （必要） |
LinkedIntegrationRuntimeType
| 名字 | 描述 | 價值 |
|---|---|---|
| authorizationType | 針對 linkedIntegrationRuntimeKeyAuthorization 類型設定為 'Key'，。 針對 linkedIntegrationRuntimeRbacAuthorization 類型設定為 'RBAC'，。 | 'Key' 'RBAC' （必要） |
ManagedIntegrationRuntime
| 名字 | 描述 | 價值 |
|---|---|---|
| managedVirtualNetwork | 受控整合運行時間受控虛擬網路。 | ManagedIntegrationRuntimeManagedVirtualNetworkReference |
| 類型 | 整合運行時間的類型。 | 'Managed' （必要） |
| typeProperties | 受控整合運行時間屬性。 | ManagedIntegrationRuntimeTypeProperties （必要） |
ManagedIntegrationRuntimeManagedVirtualNetworkReference
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 受控虛擬網路的標識碼。 | 字串 |
| referenceName | 受控虛擬網路的參考名稱 | 字串 |
| 類型 | 受控虛擬網路的類型。 | 字串 |
ManagedIntegrationRuntimeTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| computeProperties | 受控整合運行時間的計算資源。 | IntegrationRuntimeComputeProperties |
| customerVirtualNetwork | Azure-SSIS 整合運行時間將加入的虛擬網路名稱 | IntegrationRuntimeCustomerVirtualNetwork |
| ssisProperties | 受控整合運行時間的 SSIS 屬性。 | IntegrationRuntimeSsisProperties |
Microsoft.Synapse/workspaces/integrationRuntimes
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2021-06-01' |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 整合運行時間屬性。 | IntegrationRuntime （必要） |
| 類型 | 資源類型 | 'Microsoft.Synapse/workspaces/integrationRuntimes' |
SecretBase
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 將 類型設定為 'SecureString'，SecureString。 | 'SecureString' （必要） |
SecureString
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 秘密的類型。 | 字串 （必要） |
| 價值 | 安全字串的值。 | 字串 （必要） |
SecureString
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 秘密的類型。 | 'SecureString' （必要） |
| 價值 | 安全字串的值。 | 字串 （必要） |
SelfHostedIntegrationRuntime
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 整合運行時間的類型。 | 'SelfHosted' （必要） |
| typeProperties | 當這個屬性不是 Null 時，表示這是連結的整合運行時間。 屬性是用來存取原始整合運行時間。 | SelfHostedIntegrationRuntimeTypeProperties |
SelfHostedIntegrationRuntimeTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| linkedInfo | Data Factory 的連結整合運行時間類型 | LinkedIntegrationRuntimeType |
Terraform （AzAPI 提供者） 資源定義
工作區/integrationRuntimes 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Synapse/workspaces/integrationRuntimes 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01"
name = "string"
body = jsonencode({
properties = {
description = "string"
type = "string"
// For remaining properties, see IntegrationRuntime objects
}
})
}
IntegrationRuntime 物件
設定 類型 屬性，以指定物件的類型。
針對 Managed，請使用：
{
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 物件
設定 類型 屬性，以指定物件的類型。
針對 SecureString，請使用：
{
type = "SecureString"
value = "string"
}
LinkedIntegrationRuntimeType 物件
設定 authorizationType 屬性，以指定對象的類型。
針對 金鑰，請使用：
{
authorizationType = "Key"
key = {
type = "string"
value = "string"
}
}
針對 RBAC，請使用：
{
authorizationType = "RBAC"
resourceId = "string"
}
CustomSetupBase 物件
設定 類型 屬性，以指定物件的類型。
針對 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"
}
}
屬性值
CmdkeySetup
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 自訂設定的類型。 | 'CmdkeySetup' （必要） |
| typeProperties | Cmdkey 命令自定義安裝類型屬性。 | CmdkeySetupTypeProperties （必要） |
CmdkeySetupTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 密碼 | 數據源存取的密碼。 | SecretBase （必要） |
| targetName | 數據來源取的伺服器名稱。 | 任何 （必要） |
| userName | 數據來源取的用戶名稱。 | 任何 （必要） |
ComponentSetup
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 自訂設定的類型。 | 'ComponentSetup' （必要） |
| typeProperties | 安裝第三方元件類型屬性。 | LicensedComponentSetupTypeProperties （必要） |
CustomSetupBase
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 針對 cmdkeySetup 類型設定為 『CmdkeySetup』，。 將 類型設定為 'ComponentSetup' ComponentSetup。 針對 environmentVariableSetup 類型設定為 'EnvironmentVariableSetup' 。 | 'CmdkeySetup' 'ComponentSetup' 'EnvironmentVariableSetup' （必要） |
EntityReference
| 名字 | 描述 | 價值 |
|---|---|---|
| referenceName | 這個參考實體的名稱。 | 字串 |
| 類型 | 這個參考實體的類型。 | 'IntegrationRuntimeReference' 'LinkedServiceReference' |
EnvironmentVariableSetup
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 自訂設定的類型。 | 'EnvironmentVariableSetup' （必要） |
| typeProperties | 新增環境變數類型屬性。 | EnvironmentVariableSetupTypeProperties （必要） |
EnvironmentVariableSetupTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| variableName | 環境變數的名稱。 | 字串 （必要） |
| variableValue | 環境變數的值。 | 字串 （必要） |
IntegrationRuntime
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 整合運行時間描述。 | 字串 |
| 類型 | 針對 managedIntegrationRuntime 類型 設定為 'Managed'，。 針對 selfHostedIntegrationRuntime 類型設定為 'SelfHosted'，。 | 'Managed' 'SelfHosted' （必要） |
IntegrationRuntimeComputeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| dataFlowProperties | 受控整合運行時間的數據流屬性。 | IntegrationRuntimeDataFlowProperties |
| 位置 | 受控整合運行時間的位置。 在 /azure/data-factory/data-factory/data-factory-data-movement-activities 上可以找到支持的區域 | 字串 |
| maxParallelExecutionsPerNode | 受控整合運行時間每個節點的平行執行計數上限。 | int 約束： 最小值 = 1 |
| nodeSize | 受控整合運行時間的節點大小需求。 | 字串 |
| numberOfNodes | 受控整合運行時間所需的節點數目。 | int 約束： 最小值 = 1 |
| vNetProperties | 受控整合運行時間的 VNet 屬性。 | IntegrationRuntimeVNetProperties |
IntegrationRuntimeCustomerVirtualNetwork
| 名字 | 描述 | 價值 |
|---|---|---|
| subnetId | Azure-SSIS 整合運行時間要加入的子網標識碼。 | 字串 |
IntegrationRuntimeCustomSetupScriptProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| blobContainerUri | 包含自訂安裝文本的 Azure Blob 容器 URI。 | 字串 |
| sasToken | Azure Blob 容器的 SAS 令牌。 | SecureString |
IntegrationRuntimeDataFlowProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| computeType | 將執行數據流作業之叢集的計算類型。 | 'ComputeOptimized' 'General' 'MemoryOptimized' |
| coreCount | 將執行數據流作業之叢集的核心計數。 支援的值為：8、16、32、48、80、144 和 272。 | int |
| timeToLive | 將執行數據流作業的叢集存留時間（以分鐘為單位） 設定。 | int 約束： 最小值 = 0 |
IntegrationRuntimeDataProxyProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| connectVia | 自我裝載整合運行時間參考。 | EntityReference |
| 路徑 | 包含 Blob 記憶體中暫存資料的路徑。 | 字串 |
| stagingLinkedService | 暫存連結服務參考。 | EntityReference |
IntegrationRuntimeSsisCatalogInfo
| 名字 | 描述 | 價值 |
|---|---|---|
| catalogAdminPassword | 目錄資料庫的系統管理員用戶帳戶密碼。 | SecureString |
| catalogAdminUserName | 目錄資料庫的系統管理員用戶名稱。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| catalogPricingTier | 目錄資料庫的定價層。 可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效的值 | 'Basic' 'Premium' 'PremiumRS' 'Standard' |
| catalogServerEndpoint | 目錄資料庫伺服器 URL。 | 字串 |
IntegrationRuntimeSsisProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| catalogInfo | 受控專用整合運行時間的目錄資訊。 | IntegrationRuntimeSsisCatalogInfo |
| customSetupScriptProperties | 受控專用整合運行時間的自定義安裝腳本屬性。 | IntegrationRuntimeCustomSetupScriptProperties |
| dataProxyProperties | 受控專用整合運行時間的數據 Proxy 屬性。 | IntegrationRuntimeDataProxyProperties |
| 版 | SSIS Integration Runtime 的版本 | 'Enterprise' 'Standard' |
| expressCustomSetupProperties | 沒有 SSIS 整合運行時間文本屬性的自訂設定。 | CustomSetupBase[] |
| licenseType | 攜帶您自己的授權案例的授權類型。 | 'BasePrice' 'LicenseIncluded' |
IntegrationRuntimeVNetProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| publicIPs | 此整合運行時間將使用之公用IP位址的資源識別碼。 | string[] |
| 子 | 此整合運行時間將加入的子網名稱。 | 字串 |
| subnetId | 要加入此 Azure-SSIS 整合運行時間的子網標識碼。 | 字串 |
| vNetId | 此整合運行時間將加入之 VNet 的識別碼。 | 字串 |
LicensedComponentSetupTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| componentName | 第三方元件的名稱。 | 字串 （必要） |
| licenseKey | 要啟用元件的授權金鑰。 | SecretBase |
LinkedIntegrationRuntimeKeyAuthorization
| 名字 | 描述 | 價值 |
|---|---|---|
| authorizationType | 整合運行時間共享的授權類型。 | 'Key' （必要） |
| 鑰匙 | 用於授權的金鑰。 | SecureString （必要） |
LinkedIntegrationRuntimeRbacAuthorization
| 名字 | 描述 | 價值 |
|---|---|---|
| authorizationType | 整合運行時間共享的授權類型。 | 'RBAC' （必要） |
| resourceId | 要共用之整合運行時間的資源標識碼。 | 字串 （必要） |
LinkedIntegrationRuntimeType
| 名字 | 描述 | 價值 |
|---|---|---|
| authorizationType | 針對 linkedIntegrationRuntimeKeyAuthorization 類型設定為 'Key'，。 針對 linkedIntegrationRuntimeRbacAuthorization 類型設定為 'RBAC'，。 | 'Key' 'RBAC' （必要） |
ManagedIntegrationRuntime
| 名字 | 描述 | 價值 |
|---|---|---|
| managedVirtualNetwork | 受控整合運行時間受控虛擬網路。 | ManagedIntegrationRuntimeManagedVirtualNetworkReference |
| 類型 | 整合運行時間的類型。 | 'Managed' （必要） |
| typeProperties | 受控整合運行時間屬性。 | ManagedIntegrationRuntimeTypeProperties （必要） |
ManagedIntegrationRuntimeManagedVirtualNetworkReference
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 受控虛擬網路的標識碼。 | 字串 |
| referenceName | 受控虛擬網路的參考名稱 | 字串 |
| 類型 | 受控虛擬網路的類型。 | 字串 |
ManagedIntegrationRuntimeTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| computeProperties | 受控整合運行時間的計算資源。 | IntegrationRuntimeComputeProperties |
| customerVirtualNetwork | Azure-SSIS 整合運行時間將加入的虛擬網路名稱 | IntegrationRuntimeCustomerVirtualNetwork |
| ssisProperties | 受控整合運行時間的 SSIS 屬性。 | IntegrationRuntimeSsisProperties |
Microsoft.Synapse/workspaces/integrationRuntimes
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型資源的標識碼：工作區 |
| 性能 | 整合運行時間屬性。 | IntegrationRuntime （必要） |
| 類型 | 資源類型 | “Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01” |
SecretBase
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 將 類型設定為 'SecureString'，SecureString。 | 'SecureString' （必要） |
SecureString
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 秘密的類型。 | 字串 （必要） |
| 價值 | 安全字串的值。 | 字串 （必要） |
SecureString
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 秘密的類型。 | 'SecureString' （必要） |
| 價值 | 安全字串的值。 | 字串 （必要） |
SelfHostedIntegrationRuntime
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 整合運行時間的類型。 | 'SelfHosted' （必要） |
| typeProperties | 當這個屬性不是 Null 時，表示這是連結的整合運行時間。 屬性是用來存取原始整合運行時間。 | SelfHostedIntegrationRuntimeTypeProperties |
SelfHostedIntegrationRuntimeTypeProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| linkedInfo | Data Factory 的連結整合運行時間類型 | LinkedIntegrationRuntimeType |