Microsoft.Kusto/clusters 2020-06-14 - Bicep, ARM template & Terraform AzAPI reference

Bicep 資源定義

叢集資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

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

資源格式

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

resource symbolicname 'Microsoft.Kusto/clusters@2020-06-14' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    enableDiskEncryption: bool
    enableDoubleEncryption: bool
    enablePurge: bool
    enableStreamingIngest: bool
    keyVaultProperties: {
      keyName: 'string'
      keyVaultUri: 'string'
      keyVersion: 'string'
    }
    optimizedAutoscale: {
      isEnabled: bool
      maximum: int
      minimum: int
      version: int
    }
    trustedExternalTenants: [
      {
        value: 'string'
      }
    ]
    virtualNetworkConfiguration: {
      dataManagementPublicIpId: 'string'
      enginePublicIpId: 'string'
      subnetId: 'string'
    }
  }
  zones: [
    'string'
  ]
}

屬性值

集群

名字	描述	價值
名字	資源名稱	字串（必要）字元限制：4-22 合法字元：小寫字母和數位。以字母開頭。資源名稱在整個 Azure 中必須是唯一的。
位置	資源所在的地理位置	字串（必要）
標籤	資源標籤。	標記名稱和值的字典。請參閱範本中的標籤
sku	叢集的 SKU。	AzureSku （必要）
身份	如果已設定，則為叢集的身分識別。	身分識別
性能	叢集屬性。	ClusterProperties
區	叢集的可用性區域。	string[]

身份

名字	描述	價值
類型	識別類型。	'None' 'SystemAssigned' （必要）
userAssignedIdentities	與 Kusto 叢集相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。	IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

名字	描述	價值
{自定義屬性}		ComponentsSgqdofSchemasIdentityPropertiesUserassigne...

ComponentsSgqdofSchemasIdentityPropertiesUserassigne...

此物件不包含在部署期間設定的任何屬性。所有屬性都是 ReadOnly。

ClusterProperties

名字	描述	價值
enableDiskEncryption	布爾值，指出叢集的磁碟是否已加密。	bool
enableDoubleEncryption	布爾值，指出是否啟用雙重加密。	bool
enablePurge	布爾值，指出是否啟用清除作業。	bool
enableStreamingIngest	布爾值，指出是否啟用串流內嵌。	bool
keyVaultProperties	叢集加密的 KeyVault 屬性。	KeyVaultProperties
optimizedAutoscale	優化的自動調整定義。	OptimizedAutoscale
trustedExternalTenants	叢集的外部租使用者。	TrustedExternalTenant[]
virtualNetworkConfiguration	虛擬網路定義。	VirtualNetworkConfiguration

KeyVaultProperties

名字	描述	價值
keyName	金鑰儲存庫金鑰的名稱。	字串（必要）
keyVaultUri	金鑰保存庫的 URI。	字串（必要）
keyVersion	金鑰儲存庫金鑰的版本。	字串（必要）

OptimizedAutoscale

名字	描述	價值
isEnabled	布爾值，指出優化自動調整功能是否已啟用。	布林（必要）
最大	允許的實例計數上限。	int （必要）
最低	允許的實例計數下限。	int （必要）
版本	定義的範本版本，例如 1。	int （必要）

TrustedExternalTenant

名字	描述	價值
價值	代表外部租使用者的 GUID。	字串

VirtualNetworkConfiguration

名字	描述	價值
dataManagementPublicIpId	數據管理的服務公用IP位址資源標識碼。	字串（必要）
enginePublicIpId	引擎服務的公用IP位址資源標識碼。	字串（必要）
subnetId	子網資源標識碼。	字串（必要）

AzureSku

名字	描述	價值
能力	叢集實例的數目。	int
名字	SKU 名稱。	'Dev（No SLA）_Standard_D11_v2' 'Dev（No SLA）_Standard_E2a_v4' 'Standard_D11_v2' 'Standard_D12_v2' 'Standard_D13_v2' 'Standard_D14_v2' 'Standard_DS13_v2+1TB_PS' 'Standard_DS13_v2+2TB_PS' 'Standard_DS14_v2+3TB_PS' 'Standard_DS14_v2+4TB_PS' 'Standard_E16a_v4' 'Standard_E16as_v4+3TB_PS' 'Standard_E16as_v4+4TB_PS' 'Standard_E2a_v4' 'Standard_E4a_v4' 'Standard_E8a_v4' 'Standard_E8as_v4+1TB_PS' 'Standard_E8as_v4+2TB_PS' 'Standard_L16s' 'Standard_L4s' 'Standard_L8s' （必要）
層	SKU 層。	'Basic' 'Standard' （必要）

快速入門範本

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

範本	描述
建立資料庫監看員	此範例會建立 Azure SQL 的資料庫監看員，並設定其數據存放區、SQL 目標和受控私人端點
Azure Digital Twins 與時間數據歷程記錄連線	此範本會建立以時間序列數據歷程記錄連線設定的 Azure Digital Twins 實例。若要建立連線，必須建立其他資源，例如事件中樞命名空間、事件中樞、Azure 數據總管叢集和資料庫。數據會傳送至事件中樞，該中樞最終會將數據轉送至 Azure 數據總管叢集。數據會儲存在叢集中的資料庫數據表中
建立叢集資料庫	此範本可讓您建立叢集和資料庫。
使用 Cosmos DB 連線部署 Azure 數據總管 DB	使用 Cosmos DB 連線部署 Azure 數據總管 DB。
使用事件方格連線部署 Azure 數據總管資料庫	使用事件方格聯機部署 Azure 數據總管資料庫。
使用事件中樞連線部署 Azure 數據總管資料庫	使用事件中樞連線部署 Azure 數據總管資料庫。
將 Azure 數據總管叢集部署到 VNet	此範本可讓您將叢集部署至 VNet。

ARM 樣本資源定義

叢集資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

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

資源格式

若要建立 Microsoft.Kusto/clusters 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Kusto/clusters",
  "apiVersion": "2020-06-14",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "enableDiskEncryption": "bool",
    "enableDoubleEncryption": "bool",
    "enablePurge": "bool",
    "enableStreamingIngest": "bool",
    "keyVaultProperties": {
      "keyName": "string",
      "keyVaultUri": "string",
      "keyVersion": "string"
    },
    "optimizedAutoscale": {
      "isEnabled": "bool",
      "maximum": "int",
      "minimum": "int",
      "version": "int"
    },
    "trustedExternalTenants": [
      {
        "value": "string"
      }
    ],
    "virtualNetworkConfiguration": {
      "dataManagementPublicIpId": "string",
      "enginePublicIpId": "string",
      "subnetId": "string"
    }
  },
  "zones": [ "string" ]
}

屬性值

集群

名字	描述	價值
類型	資源類型	'Microsoft.Kusto/clusters'
apiVersion	資源 API 版本	'2020-06-14'
名字	資源名稱	字串（必要）字元限制：4-22 合法字元：小寫字母和數位。以字母開頭。資源名稱在整個 Azure 中必須是唯一的。
位置	資源所在的地理位置	字串（必要）
標籤	資源標籤。	標記名稱和值的字典。請參閱範本中的標籤
sku	叢集的 SKU。	AzureSku （必要）
身份	如果已設定，則為叢集的身分識別。	身分識別
性能	叢集屬性。	ClusterProperties
區	叢集的可用性區域。	string[]

身份

名字	描述	價值
類型	識別類型。	'None' 'SystemAssigned' （必要）
userAssignedIdentities	與 Kusto 叢集相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。	IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

名字	描述	價值
{自定義屬性}		ComponentsSgqdofSchemasIdentityPropertiesUserassigne...

ComponentsSgqdofSchemasIdentityPropertiesUserassigne...

此物件不包含在部署期間設定的任何屬性。所有屬性都是 ReadOnly。

ClusterProperties

名字	描述	價值
enableDiskEncryption	布爾值，指出叢集的磁碟是否已加密。	bool
enableDoubleEncryption	布爾值，指出是否啟用雙重加密。	bool
enablePurge	布爾值，指出是否啟用清除作業。	bool
enableStreamingIngest	布爾值，指出是否啟用串流內嵌。	bool
keyVaultProperties	叢集加密的 KeyVault 屬性。	KeyVaultProperties
optimizedAutoscale	優化的自動調整定義。	OptimizedAutoscale
trustedExternalTenants	叢集的外部租使用者。	TrustedExternalTenant[]
virtualNetworkConfiguration	虛擬網路定義。	VirtualNetworkConfiguration

KeyVaultProperties

名字	描述	價值
keyName	金鑰儲存庫金鑰的名稱。	字串（必要）
keyVaultUri	金鑰保存庫的 URI。	字串（必要）
keyVersion	金鑰儲存庫金鑰的版本。	字串（必要）

OptimizedAutoscale

名字	描述	價值
isEnabled	布爾值，指出優化自動調整功能是否已啟用。	布林（必要）
最大	允許的實例計數上限。	int （必要）
最低	允許的實例計數下限。	int （必要）
版本	定義的範本版本，例如 1。	int （必要）

TrustedExternalTenant

名字	描述	價值
價值	代表外部租使用者的 GUID。	字串

VirtualNetworkConfiguration

名字	描述	價值
dataManagementPublicIpId	數據管理的服務公用IP位址資源標識碼。	字串（必要）
enginePublicIpId	引擎服務的公用IP位址資源標識碼。	字串（必要）
subnetId	子網資源標識碼。	字串（必要）

AzureSku

名字	描述	價值
能力	叢集實例的數目。	int
名字	SKU 名稱。	'Dev（No SLA）_Standard_D11_v2' 'Dev（No SLA）_Standard_E2a_v4' 'Standard_D11_v2' 'Standard_D12_v2' 'Standard_D13_v2' 'Standard_D14_v2' 'Standard_DS13_v2+1TB_PS' 'Standard_DS13_v2+2TB_PS' 'Standard_DS14_v2+3TB_PS' 'Standard_DS14_v2+4TB_PS' 'Standard_E16a_v4' 'Standard_E16as_v4+3TB_PS' 'Standard_E16as_v4+4TB_PS' 'Standard_E2a_v4' 'Standard_E4a_v4' 'Standard_E8a_v4' 'Standard_E8as_v4+1TB_PS' 'Standard_E8as_v4+2TB_PS' 'Standard_L16s' 'Standard_L4s' 'Standard_L8s' （必要）
層	SKU 層。	'Basic' 'Standard' （必要）

快速入門範本

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

範本	描述
建立資料庫監看員	此範例會建立 Azure SQL 的資料庫監看員，並設定其數據存放區、SQL 目標和受控私人端點
Azure Digital Twins 與時間數據歷程記錄連線	此範本會建立以時間序列數據歷程記錄連線設定的 Azure Digital Twins 實例。若要建立連線，必須建立其他資源，例如事件中樞命名空間、事件中樞、Azure 數據總管叢集和資料庫。數據會傳送至事件中樞，該中樞最終會將數據轉送至 Azure 數據總管叢集。數據會儲存在叢集中的資料庫數據表中
建立叢集資料庫	此範本可讓您建立叢集和資料庫。
使用 Cosmos DB 連線部署 Azure 數據總管 DB	使用 Cosmos DB 連線部署 Azure 數據總管 DB。
使用事件方格連線部署 Azure 數據總管資料庫	使用事件方格聯機部署 Azure 數據總管資料庫。
使用事件中樞連線部署 Azure 數據總管資料庫	使用事件中樞連線部署 Azure 數據總管資料庫。
將 Azure 數據總管叢集部署到 VNet	此範本可讓您將叢集部署至 VNet。

Terraform （AzAPI 提供者）資源定義

叢集資源類型可以使用目標作業來部署：

資源群組

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

資源格式

若要建立 Microsoft.Kusto/clusters 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Kusto/clusters@2020-06-14"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      enableDiskEncryption = bool
      enableDoubleEncryption = bool
      enablePurge = bool
      enableStreamingIngest = bool
      keyVaultProperties = {
        keyName = "string"
        keyVaultUri = "string"
        keyVersion = "string"
      }
      optimizedAutoscale = {
        isEnabled = bool
        maximum = int
        minimum = int
        version = int
      }
      trustedExternalTenants = [
        {
          value = "string"
        }
      ]
      virtualNetworkConfiguration = {
        dataManagementPublicIpId = "string"
        enginePublicIpId = "string"
        subnetId = "string"
      }
    }
    zones = [
      "string"
    ]
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

屬性值

集群

名字	描述	價值
類型	資源類型	“Microsoft.Kusto/clusters@2020-06-14”
名字	資源名稱	字串（必要）字元限制：4-22 合法字元：小寫字母和數位。以字母開頭。資源名稱在整個 Azure 中必須是唯一的。
位置	資源所在的地理位置	字串（必要）
parent_id	若要部署至資源群組，請使用該資源群組的標識碼。	字串（必要）
標籤	資源標籤。	標記名稱和值的字典。
sku	叢集的 SKU。	AzureSku （必要）
身份	如果已設定，則為叢集的身分識別。	身分識別
性能	叢集屬性。	ClusterProperties
區	叢集的可用性區域。	string[]

身份

名字	描述	價值
類型	識別類型。	“SystemAssigned” （必要）
identity_ids	與 Kusto 叢集相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。	使用者身分識別標識碼的陣列。

IdentityUserAssignedIdentities

名字	描述	價值
{自定義屬性}		ComponentsSgqdofSchemasIdentityPropertiesUserassigne...

ComponentsSgqdofSchemasIdentityPropertiesUserassigne...

此物件不包含在部署期間設定的任何屬性。所有屬性都是 ReadOnly。

ClusterProperties

名字	描述	價值
enableDiskEncryption	布爾值，指出叢集的磁碟是否已加密。	bool
enableDoubleEncryption	布爾值，指出是否啟用雙重加密。	bool
enablePurge	布爾值，指出是否啟用清除作業。	bool
enableStreamingIngest	布爾值，指出是否啟用串流內嵌。	bool
keyVaultProperties	叢集加密的 KeyVault 屬性。	KeyVaultProperties
optimizedAutoscale	優化的自動調整定義。	OptimizedAutoscale
trustedExternalTenants	叢集的外部租使用者。	TrustedExternalTenant[]
virtualNetworkConfiguration	虛擬網路定義。	VirtualNetworkConfiguration

KeyVaultProperties

名字	描述	價值
keyName	金鑰儲存庫金鑰的名稱。	字串（必要）
keyVaultUri	金鑰保存庫的 URI。	字串（必要）
keyVersion	金鑰儲存庫金鑰的版本。	字串（必要）

OptimizedAutoscale

名字	描述	價值
isEnabled	布爾值，指出優化自動調整功能是否已啟用。	布林（必要）
最大	允許的實例計數上限。	int （必要）
最低	允許的實例計數下限。	int （必要）
版本	定義的範本版本，例如 1。	int （必要）

TrustedExternalTenant

名字	描述	價值
價值	代表外部租使用者的 GUID。	字串

VirtualNetworkConfiguration

名字	描述	價值
dataManagementPublicIpId	數據管理的服務公用IP位址資源標識碼。	字串（必要）
enginePublicIpId	引擎服務的公用IP位址資源標識碼。	字串（必要）
subnetId	子網資源標識碼。	字串（必要）

AzureSku

名字	描述	價值
能力	叢集實例的數目。	int
名字	SKU 名稱。	“Dev（No SLA）_Standard_D11_v2” “Dev（無 SLA）_Standard_E2a_v4” “Standard_D11_v2” “Standard_D12_v2” “Standard_D13_v2” “Standard_D14_v2” “Standard_DS13_v2+1TB_PS” “Standard_DS13_v2+2TB_PS” “Standard_DS14_v2+3TB_PS” “Standard_DS14_v2+4TB_PS” “Standard_E16a_v4” “Standard_E16as_v4+3TB_PS” “Standard_E16as_v4+4TB_PS” “Standard_E2a_v4” “Standard_E4a_v4” “Standard_E8a_v4” “Standard_E8as_v4+1TB_PS” “Standard_E8as_v4+2TB_PS” “Standard_L16s” “Standard_L4s” “Standard_L8s” （必要）
層	SKU 層。	“Basic” “Standard” （必要）

共用方式為

Microsoft.Kusto 叢集 2020-06-14

Bicep 資源定義

資源格式

屬性值

集群

身份

IdentityUserAssignedIdentities

ComponentsSgqdofSchemasIdentityPropertiesUserassigne...

ClusterProperties

KeyVaultProperties

OptimizedAutoscale

TrustedExternalTenant

VirtualNetworkConfiguration

AzureSku

快速入門範本

ARM 樣本資源定義

資源格式

屬性值

集群

身份

IdentityUserAssignedIdentities

ComponentsSgqdofSchemasIdentityPropertiesUserassigne...

ClusterProperties

KeyVaultProperties

OptimizedAutoscale

TrustedExternalTenant

VirtualNetworkConfiguration

AzureSku

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

集群

身份

IdentityUserAssignedIdentities

ComponentsSgqdofSchemasIdentityPropertiesUserassigne...

ClusterProperties

KeyVaultProperties

OptimizedAutoscale

TrustedExternalTenant

VirtualNetworkConfiguration

AzureSku

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義