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

Clusters - Create Or Update

参考

服务:: Azure Kusto

API 版本:: 2024-04-13

创建或更新 Kusto 群集。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}?api-version=2024-04-13

URI 参数

名称	在	必需	类型	说明
clusterName	path	True	string	Kusto 群集的名称。正则表达式模式: `^.*$`
resourceGroupName	path	True	string	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	用于此操作的 API 版本。

请求头

名称	必需	类型	说明
If-Match		string	群集的 ETag。省略此值以始终覆盖当前群集。指定最后一次看到的 ETag 值，以防止意外覆盖并发更改。
If-None-Match		string	设置为“*”以允许创建新群集，但要防止更新现有群集。其他值将导致 412 预条件失败响应。

请求正文

名称	必需	类型	说明
location	True	string	资源所在的地理位置
sku	True	AzureSku	群集的 SKU。
identity		Identity	群集的标识（如果已配置）。
properties.acceptedAudiences		AcceptedAudiences[]	群集的接受受众。
properties.allowedFqdnList		string[]	群集出口允许的 FQDN（完全限定域名）列表。
properties.allowedIpRangeList		string[]	允许连接到群集的 CIDR 格式的 IP 列表。
properties.calloutPolicies		CalloutPolicy[]	群集出口的标注策略列表。
properties.enableAutoStop		boolean	一个布尔值，该值指示群集是否可以自动停止（由于数据不足或没有活动数天）。
properties.enableDiskEncryption		boolean	一个布尔值，该值指示群集的磁盘是否已加密。
properties.enableDoubleEncryption		boolean	一个布尔值，该值指示是否启用了双重加密。
properties.enablePurge		boolean	一个布尔值，该值指示是否启用了清除操作。
properties.enableStreamingIngest		boolean	一个布尔值，该值指示是否启用了流式引入。
properties.engineType		EngineType	引擎类型
properties.keyVaultProperties		KeyVaultProperties	群集加密的 KeyVault 属性。
properties.languageExtensions		LanguageExtensionsList	群集的语言扩展列表。
properties.optimizedAutoscale		OptimizedAutoscale	优化的自动缩放定义。
properties.publicIPType		publicIPType	指示要创建的公共 IP 类型 - IPv4（默认）或 DualStack （IPv4 和 IPv6）
properties.publicNetworkAccess		PublicNetworkAccess	默认情况下启用对群集的公共网络访问。禁用后，仅允许与群集建立专用终结点连接
properties.restrictOutboundNetworkAccess		ClusterNetworkAccessFlag	是否限制出站网络访问。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”
properties.trustedExternalTenants		TrustedExternalTenant[]	群集的外部租户。
properties.virtualClusterGraduationProperties		string	虚拟群集毕业属性
properties.virtualNetworkConfiguration		VirtualNetworkConfiguration	虚拟网络定义。
tags		object	资源标记。
zones		string[]	群集的可用性区域。

响应

名称	类型	说明
200 OK	Cluster	已成功更新群集。
201 Created	Cluster	已成功创建群集。
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

示例

KustoClustersCreateOrUpdate

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster?api-version=2024-04-13

{
  "location": "westus",
  "sku": {
    "name": "Standard_L16as_v3",
    "capacity": 2,
    "tier": "Standard"
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "enableStreamingIngest": true,
    "enablePurge": true,
    "enableDoubleEncryption": false,
    "enableAutoStop": true,
    "publicIPType": "DualStack",
    "publicNetworkAccess": "Enabled",
    "allowedIpRangeList": [
      "0.0.0.0/0"
    ],
    "languageExtensions": {
      "value": [
        {
          "languageExtensionName": "PYTHON",
          "languageExtensionImageName": "Python3_10_8"
        },
        {
          "languageExtensionName": "R",
          "languageExtensionImageName": "R"
        }
      ]
    }
  }
}

示例响应

状态代码:: 200

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster",
  "name": "kustoCluster",
  "type": "Microsoft.Kusto/Clusters",
  "location": "westus",
  "properties": {
    "provisioningState": "Succeeded",
    "enableDiskEncryption": false,
    "enableStreamingIngest": true,
    "enablePurge": true,
    "enableDoubleEncryption": false,
    "enableAutoStop": true,
    "publicIPType": "DualStack",
    "keyVaultProperties": {
      "keyVaultUri": "https://dummy.keyvault.com",
      "keyName": "keyName",
      "keyVersion": "keyVersion"
    },
    "engineType": "V3",
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Disabled",
    "allowedIpRangeList": [
      "0.0.0.0/0"
    ],
    "languageExtensions": {
      "value": [
        {
          "languageExtensionName": "PYTHON",
          "languageExtensionImageName": "Python3_10_8"
        },
        {
          "languageExtensionName": "R",
          "languageExtensionImageName": "R"
        }
      ]
    }
  },
  "sku": {
    "name": "Standard_L16as_v3",
    "capacity": 2,
    "tier": "Standard"
  },
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4",
    "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c",
    "userAssignedIdentities": {}
  },
  "etag": "abcd"
}

状态代码:: 201

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster",
  "name": "kustoCluster",
  "type": "Microsoft.Kusto/Clusters",
  "location": "westus",
  "properties": {
    "provisioningState": "Succeeded",
    "enableDiskEncryption": false,
    "enableStreamingIngest": true,
    "enablePurge": true,
    "enableDoubleEncryption": false,
    "enableAutoStop": true,
    "publicIPType": "DualStack",
    "keyVaultProperties": {
      "keyVaultUri": "https://dummy.keyvault.com",
      "keyName": "keyName",
      "keyVersion": "keyVersion"
    },
    "engineType": "V3",
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Disabled",
    "allowedIpRangeList": [
      "0.0.0.0/0"
    ],
    "languageExtensions": {
      "value": [
        {
          "languageExtensionName": "PYTHON",
          "languageExtensionImageName": "Python3_10_8"
        },
        {
          "languageExtensionName": "R",
          "languageExtensionImageName": "R"
        }
      ]
    }
  },
  "sku": {
    "name": "Standard_L16as_v3",
    "capacity": 2,
    "tier": "Standard"
  },
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4",
    "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c",
    "userAssignedIdentities": {}
  },
  "etag": "abcd123"
}

定义

名称	说明
AcceptedAudiences	表示群集信任的接受受众。
AzureSku	Azure SKU 定义。
AzureSkuName	SKU 名称。
AzureSkuTier	SKU 层。
CalloutPolicy	外部标注策略的配置，包括 URI 模式、访问类型和服务类型。
calloutType	标注服务的类型，指定要访问的外部资源或服务的类型。
Cluster	表示 Kusto 群集的类。
ClusterNetworkAccessFlag	是否限制出站网络访问。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”
createdByType	创建资源的标识的类型。
EngineType	引擎类型
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
Identity	资源的标识。
IdentityType	使用的托管标识的类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将删除所有标识。
KeyVaultProperties	密钥保管库的属性。
LanguageExtension	语言扩展对象。
languageExtensionImageName	语言扩展映像名称。
languageExtensionName	语言扩展名称。
LanguageExtensionsList	语言扩展对象列表。
MigrationClusterProperties	表示属于迁移的群集的属性。
MigrationClusterRole	群集在迁移过程中的角色。
OptimizedAutoscale	一个包含优化自动缩放定义的类。
outboundAccess	指示是否允许对指定的 URI 模式进行出站访问。
PrivateEndpointConnection	专用终结点连接
PrivateEndpointProperty	连接所属的专用终结点。
PrivateLinkServiceConnectionStateProperty	专用终结点连接的连接状态。
ProvisioningState	资源的预配状态。
publicIPType	指示要创建的公共 IP 类型 - IPv4（默认）或 DualStack （IPv4 和 IPv6）
PublicNetworkAccess	默认情况下启用对群集的公共网络访问。禁用后，仅允许与群集建立专用终结点连接
State	资源的状态。
systemData	与创建和上次修改资源相关的元数据。
TrustedExternalTenant	表示群集信任的租户 ID。
UserAssignedIdentities	与 Kusto 群集关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
VirtualNetworkConfiguration	包含虚拟网络定义的类。
VnetState	启用后，群集将部署到配置的子网中，禁用后将从子网中删除该群集。
ZoneStatus	指示群集是区域性群集还是非区域性群集。

AcceptedAudiences

表示群集信任的接受受众。

名称	类型	说明
value	string	表示接受受众的 GUID 或有效 URL。

AzureSku

Azure SKU 定义。

名称	类型	说明
capacity	integer	群集的实例数。
name	AzureSkuName	SKU 名称。
tier	AzureSkuTier	SKU 层。

AzureSkuName

SKU 名称。

名称	类型	说明
Dev(No SLA)_Standard_D11_v2	string
Dev(No SLA)_Standard_E2a_v4	string
Standard_D11_v2	string
Standard_D12_v2	string
Standard_D13_v2	string
Standard_D14_v2	string
Standard_D16d_v5	string
Standard_D32d_v4	string
Standard_D32d_v5	string
Standard_DS13_v2+1TB_PS	string
Standard_DS13_v2+2TB_PS	string
Standard_DS14_v2+3TB_PS	string
Standard_DS14_v2+4TB_PS	string
Standard_E16a_v4	string
Standard_E16ads_v5	string
Standard_E16as_v4+3TB_PS	string
Standard_E16as_v4+4TB_PS	string
Standard_E16as_v5+3TB_PS	string
Standard_E16as_v5+4TB_PS	string
Standard_E16d_v4	string
Standard_E16d_v5	string
Standard_E16s_v4+3TB_PS	string
Standard_E16s_v4+4TB_PS	string
Standard_E16s_v5+3TB_PS	string
Standard_E16s_v5+4TB_PS	string
Standard_E2a_v4	string
Standard_E2ads_v5	string
Standard_E2d_v4	string
Standard_E2d_v5	string
Standard_E4a_v4	string
Standard_E4ads_v5	string
Standard_E4d_v4	string
Standard_E4d_v5	string
Standard_E64i_v3	string
Standard_E80ids_v4	string
Standard_E8a_v4	string
Standard_E8ads_v5	string
Standard_E8as_v4+1TB_PS	string
Standard_E8as_v4+2TB_PS	string
Standard_E8as_v5+1TB_PS	string
Standard_E8as_v5+2TB_PS	string
Standard_E8d_v4	string
Standard_E8d_v5	string
Standard_E8s_v4+1TB_PS	string
Standard_E8s_v4+2TB_PS	string
Standard_E8s_v5+1TB_PS	string
Standard_E8s_v5+2TB_PS	string
Standard_EC16ads_v5	string
Standard_EC16as_v5+3TB_PS	string
Standard_EC16as_v5+4TB_PS	string
Standard_EC8ads_v5	string
Standard_EC8as_v5+1TB_PS	string
Standard_EC8as_v5+2TB_PS	string
Standard_L16as_v3	string
Standard_L16s	string
Standard_L16s_v2	string
Standard_L16s_v3	string
Standard_L32as_v3	string
Standard_L32s_v3	string
Standard_L4s	string
Standard_L8as_v3	string
Standard_L8s	string
Standard_L8s_v2	string
Standard_L8s_v3	string

AzureSkuTier

SKU 层。

名称	类型	说明
Basic	string
Standard	string

CalloutPolicy

外部标注策略的配置，包括 URI 模式、访问类型和服务类型。

名称	类型	说明
calloutId	string	标注配置的唯一标识符。
calloutType	calloutType	标注服务的类型，指定要访问的外部资源或服务的类型。
calloutUriRegex	string	标注 URI 的正则表达式或 FQDN 模式。
outboundAccess	outboundAccess	指示是否允许对指定的 URI 模式进行出站访问。

calloutType

标注服务的类型，指定要访问的外部资源或服务的类型。

名称	类型	说明
azure_digital_twins	string
azure_openai	string
cosmosdb	string
external_data	string
genevametrics	string
kusto	string
mysql	string
postgresql	string
sandbox_artifacts	string
sql	string
webapi	string

Cluster

表示 Kusto 群集的类。

名称	类型	默认值	说明
etag	string		一个唯一的只读字符串，每当更新资源时更改。
id	string		资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		群集的标识（如果已配置）。
location	string		资源所在的地理位置
name	string		资源的名称
properties.acceptedAudiences	AcceptedAudiences[]		群集的接受受众。
properties.allowedFqdnList	string[]		群集出口允许的 FQDN（完全限定域名）列表。
properties.allowedIpRangeList	string[]		允许连接到群集的 CIDR 格式的 IP 列表。
properties.calloutPolicies	CalloutPolicy[]		群集出口的标注策略列表。
properties.dataIngestionUri	string		群集数据引入 URI。
properties.enableAutoStop	boolean	True	一个布尔值，该值指示群集是否可以自动停止（由于数据不足或没有活动数天）。
properties.enableDiskEncryption	boolean	False	一个布尔值，该值指示群集的磁盘是否已加密。
properties.enableDoubleEncryption	boolean	False	一个布尔值，该值指示是否启用了双重加密。
properties.enablePurge	boolean	False	一个布尔值，该值指示是否启用了清除操作。
properties.enableStreamingIngest	boolean	False	一个布尔值，该值指示是否启用了流式引入。
properties.engineType	EngineType	V3	引擎类型
properties.keyVaultProperties	KeyVaultProperties		群集加密的 KeyVault 属性。
properties.languageExtensions	LanguageExtensionsList		群集的语言扩展列表。
properties.migrationCluster	MigrationClusterProperties		迁移到/从此群集进行迁移时涉及的对等群集的属性。
properties.optimizedAutoscale	OptimizedAutoscale		优化的自动缩放定义。
properties.privateEndpointConnections	PrivateEndpointConnection[]		专用终结点连接的列表。
properties.provisioningState	ProvisioningState		资源的预配状态。
properties.publicIPType	publicIPType	IPv4	指示要创建的公共 IP 类型 - IPv4（默认）或 DualStack （IPv4 和 IPv6）
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	默认情况下启用对群集的公共网络访问。禁用后，仅允许与群集建立专用终结点连接
properties.restrictOutboundNetworkAccess	ClusterNetworkAccessFlag	Disabled	是否限制出站网络访问。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”
properties.state	State		资源的状态。
properties.stateReason	string		群集当前状态的原因。
properties.trustedExternalTenants	TrustedExternalTenant[]		群集的外部租户。
properties.uri	string		群集 URI。
properties.virtualClusterGraduationProperties	string		虚拟群集毕业属性
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		虚拟网络定义。
properties.zoneStatus	ZoneStatus		指示群集是区域性群集还是非区域性群集。
sku	AzureSku		群集的 SKU。
systemData	systemData		与创建和上次修改资源相关的元数据。
tags	object		资源标记。
type	string		资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”
zones	string[]		群集的可用性区域。

ClusterNetworkAccessFlag

是否限制出站网络访问。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”

名称	类型	说明
Disabled	string
Enabled	string

createdByType

创建资源的标识的类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

EngineType

引擎类型

名称	类型	说明
V2	string
V3	string

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

Identity

资源的标识。

名称	类型	说明
principalId	string	资源标识的主体 ID。
tenantId	string	资源的租户 ID。
type	IdentityType	使用的托管标识的类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将删除所有标识。
userAssignedIdentities	UserAssignedIdentities	与 Kusto 群集关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

IdentityType

使用的托管标识的类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将删除所有标识。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

KeyVaultProperties

密钥保管库的属性。

名称	类型	说明
keyName	string	密钥保管库密钥的名称。
keyVaultUri	string	密钥保管库的 URI。
keyVersion	string	密钥保管库密钥的版本。
userIdentity	string	有权访问密钥的用户分配标识（ARM 资源 ID）。

LanguageExtension

语言扩展对象。

名称	类型	说明
languageExtensionCustomImageName	string	语言扩展自定义映像名称。
languageExtensionImageName	languageExtensionImageName	语言扩展映像名称。
languageExtensionName	languageExtensionName	语言扩展名称。

languageExtensionImageName

语言扩展映像名称。

名称	类型	说明
Python3_10_8	string
Python3_10_8_DL	string
Python3_11_7	string
Python3_11_7_DL	string
Python3_6_5	string
PythonCustomImage	string
R	string

languageExtensionName

语言扩展名称。

名称	类型	说明
PYTHON	string
R	string

LanguageExtensionsList

语言扩展对象列表。

名称	类型	说明
value	LanguageExtension[]	语言扩展列表。

MigrationClusterProperties

表示属于迁移的群集的属性。

名称	类型	说明
dataIngestionUri	string	群集的公共数据引入 URL。
id	string	群集的资源 ID。
role	MigrationClusterRole	群集在迁移过程中的角色。
uri	string	群集的公共 URL。

MigrationClusterRole

群集在迁移过程中的角色。

名称	类型	说明
Destination	string
Source	string

OptimizedAutoscale

一个包含优化自动缩放定义的类。

名称	类型	说明
isEnabled	boolean	一个布尔值，该值指示是否启用了优化的自动缩放功能。
maximum	integer	允许的最大实例计数。
minimum	integer	允许的最小实例计数。
version	integer	定义的模板版本，例如 1。

outboundAccess

指示是否允许对指定的 URI 模式进行出站访问。

名称	类型	说明
Allow	string
Deny	string

PrivateEndpointConnection

专用终结点连接

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.groupId	string	专用终结点的组 ID。
properties.privateEndpoint	PrivateEndpointProperty	连接所属的专用终结点。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	专用终结点连接的连接状态。
properties.provisioningState	string	专用终结点的预配状态。
systemData	systemData	与创建和上次修改资源相关的元数据。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointProperty

连接所属的专用终结点。

名称	类型	说明
id	string	专用终结点的资源 ID。

PrivateLinkServiceConnectionStateProperty

专用终结点连接的连接状态。

名称	类型	说明
actionsRequired	string	除基本工作流之外所需的任何操作（批准/拒绝/断开连接）
description	string	专用链接服务连接说明。
status	string	专用链接服务连接状态。

ProvisioningState

资源的预配状态。

名称	类型	说明
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
Running	string
Succeeded	string

publicIPType

指示要创建的公共 IP 类型 - IPv4（默认）或 DualStack （IPv4 和 IPv6）

名称	类型	说明
DualStack	string
IPv4	string

PublicNetworkAccess

默认情况下启用对群集的公共网络访问。禁用后，仅允许与群集建立专用终结点连接

名称	类型	说明
Disabled	string
Enabled	string

State

资源的状态。

名称	类型	说明
Creating	string
Deleted	string
Deleting	string
Migrated	string
Running	string
Starting	string
Stopped	string
Stopping	string
Unavailable	string
Updating	string

systemData

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

TrustedExternalTenant

表示群集信任的租户 ID。

名称	类型	说明
value	string	表示外部租户的 GUID。

UserAssignedIdentities

与 Kusto 群集关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

名称	类型	说明

VirtualNetworkConfiguration

包含虚拟网络定义的类。

名称	类型	默认值	说明
dataManagementPublicIpId	string		数据管理的服务公共 IP 地址资源 ID。
enginePublicIpId	string		引擎服务的公共 IP 地址资源 ID。
state	VnetState	Enabled	启用后，群集将部署到配置的子网中，禁用后将从子网中删除该群集。
subnetId	string		子网资源 ID。

VnetState

启用后，群集将部署到配置的子网中，禁用后将从子网中删除该群集。

名称	类型	说明
Disabled	string
Enabled	string

ZoneStatus

指示群集是区域性群集还是非区域性群集。

名称	类型	说明
NonZonal	string
Zonal	string
ZonalInconsistency	string

通过