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 參數

名稱	位於	必要	類型	Description
clusterName	path	True	string pattern: ^.*$	Kusto 叢集的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求標頭

名稱	必要	類型	Description
If-Match		string	叢集的 ETag。 請省略此值以一律覆寫目前的叢集。 指定最後看到的 ETag 值，以防止意外覆寫並行變更。
If-None-Match		string	設定為 『*』 以允許建立新的叢集，但為了避免更新現有的叢集。 其他值會導致 412 前置條件失敗的回應。

要求本文

名稱	必要	類型	Description
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[]	叢集的可用性區域。

回應

名稱	類型	Description
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"
        }
      ]
    }
  }
}

Java

import com.azure.resourcemanager.kusto.fluent.models.LanguageExtensionInner;
import com.azure.resourcemanager.kusto.models.AzureSku;
import com.azure.resourcemanager.kusto.models.AzureSkuName;
import com.azure.resourcemanager.kusto.models.AzureSkuTier;
import com.azure.resourcemanager.kusto.models.Identity;
import com.azure.resourcemanager.kusto.models.IdentityType;
import com.azure.resourcemanager.kusto.models.LanguageExtensionImageName;
import com.azure.resourcemanager.kusto.models.LanguageExtensionName;
import com.azure.resourcemanager.kusto.models.LanguageExtensionsList;
import com.azure.resourcemanager.kusto.models.PublicIpType;
import com.azure.resourcemanager.kusto.models.PublicNetworkAccess;
import java.util.Arrays;

/**
 * Samples for Clusters CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoClustersCreateOrUpdate
     * .json
     */
    /**
     * Sample code: KustoClustersCreateOrUpdate.
     * 
     * @param manager Entry point to KustoManager.
     */
    public static void kustoClustersCreateOrUpdate(com.azure.resourcemanager.kusto.KustoManager manager) {
        manager.clusters().define("kustoCluster").withRegion("westus").withExistingResourceGroup("kustorptest")
            .withSku(
                new AzureSku().withName(AzureSkuName.STANDARD_L16AS_V3).withCapacity(2).withTier(AzureSkuTier.STANDARD))
            .withIdentity(new Identity().withType(IdentityType.SYSTEM_ASSIGNED)).withEnableStreamingIngest(true)
            .withEnablePurge(true)
            .withLanguageExtensions(new LanguageExtensionsList().withValue(Arrays.asList(
                new LanguageExtensionInner().withLanguageExtensionName(LanguageExtensionName.PYTHON)
                    .withLanguageExtensionImageName(LanguageExtensionImageName.PYTHON3_10_8),
                new LanguageExtensionInner().withLanguageExtensionName(LanguageExtensionName.R)
                    .withLanguageExtensionImageName(LanguageExtensionImageName.R))))
            .withEnableDoubleEncryption(false).withPublicNetworkAccess(PublicNetworkAccess.ENABLED)
            .withAllowedIpRangeList(Arrays.asList("0.0.0.0/0")).withEnableAutoStop(true)
            .withPublicIpType(PublicIpType.DUAL_STACK).create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.kusto import KustoManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-kusto
# USAGE
    python kusto_clusters_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KustoManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-123456789098",
    )

    response = client.clusters.begin_create_or_update(
        resource_group_name="kustorptest",
        cluster_name="kustoCluster",
        parameters={
            "identity": {"type": "SystemAssigned"},
            "location": "westus",
            "properties": {
                "allowedIpRangeList": ["0.0.0.0/0"],
                "enableAutoStop": True,
                "enableDoubleEncryption": False,
                "enablePurge": True,
                "enableStreamingIngest": True,
                "languageExtensions": {
                    "value": [
                        {"languageExtensionImageName": "Python3_10_8", "languageExtensionName": "PYTHON"},
                        {"languageExtensionImageName": "R", "languageExtensionName": "R"},
                    ]
                },
                "publicIPType": "DualStack",
                "publicNetworkAccess": "Enabled",
            },
            "sku": {"capacity": 2, "name": "Standard_L16as_v3", "tier": "Standard"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoClustersCreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armkusto_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kusto/armkusto/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b8adce17dc500f338f86f18af30aac61dcb71c5f/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoClustersCreateOrUpdate.json
func ExampleClustersClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClustersClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", armkusto.Cluster{
		Location: to.Ptr("westus"),
		Identity: &armkusto.Identity{
			Type: to.Ptr(armkusto.IdentityTypeSystemAssigned),
		},
		Properties: &armkusto.ClusterProperties{
			AllowedIPRangeList: []*string{
				to.Ptr("0.0.0.0/0")},
			EnableAutoStop:         to.Ptr(true),
			EnableDoubleEncryption: to.Ptr(false),
			EnablePurge:            to.Ptr(true),
			EnableStreamingIngest:  to.Ptr(true),
			LanguageExtensions: &armkusto.LanguageExtensionsList{
				Value: []*armkusto.LanguageExtension{
					{
						LanguageExtensionImageName: to.Ptr(armkusto.LanguageExtensionImageNamePython3108),
						LanguageExtensionName:      to.Ptr(armkusto.LanguageExtensionNamePYTHON),
					},
					{
						LanguageExtensionImageName: to.Ptr(armkusto.LanguageExtensionImageNameR),
						LanguageExtensionName:      to.Ptr(armkusto.LanguageExtensionNameR),
					}},
			},
			PublicIPType:        to.Ptr(armkusto.PublicIPTypeDualStack),
			PublicNetworkAccess: to.Ptr(armkusto.PublicNetworkAccessEnabled),
		},
		SKU: &armkusto.AzureSKU{
			Name:     to.Ptr(armkusto.AzureSKUNameStandardL16AsV3),
			Capacity: to.Ptr[int32](2),
			Tier:     to.Ptr(armkusto.AzureSKUTierStandard),
		},
	}, &armkusto.ClustersClientBeginCreateOrUpdateOptions{IfMatch: nil,
		IfNoneMatch: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Cluster = armkusto.Cluster{
	// 	Name: to.Ptr("kustoCluster"),
	// 	Type: to.Ptr("Microsoft.Kusto/Clusters"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster"),
	// 	Location: to.Ptr("westus"),
	// 	Etag: to.Ptr("abcd"),
	// 	Identity: &armkusto.Identity{
	// 		Type: to.Ptr(armkusto.IdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("faabad1f-4876-463c-af9d-6ba2d2d2394c"),
	// 		TenantID: to.Ptr("b932977f-6277-4ab7-a2cd-5bd21f07aaf4"),
	// 		UserAssignedIdentities: map[string]*armkusto.ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 		},
	// 	},
	// 	Properties: &armkusto.ClusterProperties{
	// 		AllowedIPRangeList: []*string{
	// 			to.Ptr("0.0.0.0/0")},
	// 			EnableAutoStop: to.Ptr(true),
	// 			EnableDiskEncryption: to.Ptr(false),
	// 			EnableDoubleEncryption: to.Ptr(false),
	// 			EnablePurge: to.Ptr(true),
	// 			EnableStreamingIngest: to.Ptr(true),
	// 			EngineType: to.Ptr(armkusto.EngineTypeV3),
	// 			KeyVaultProperties: &armkusto.KeyVaultProperties{
	// 				KeyName: to.Ptr("keyName"),
	// 				KeyVaultURI: to.Ptr("https://dummy.keyvault.com"),
	// 				KeyVersion: to.Ptr("keyVersion"),
	// 			},
	// 			LanguageExtensions: &armkusto.LanguageExtensionsList{
	// 				Value: []*armkusto.LanguageExtension{
	// 					{
	// 						LanguageExtensionImageName: to.Ptr(armkusto.LanguageExtensionImageNamePython3108),
	// 						LanguageExtensionName: to.Ptr(armkusto.LanguageExtensionNamePYTHON),
	// 					},
	// 					{
	// 						LanguageExtensionImageName: to.Ptr(armkusto.LanguageExtensionImageNameR),
	// 						LanguageExtensionName: to.Ptr(armkusto.LanguageExtensionNameR),
	// 				}},
	// 			},
	// 			ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 			PublicIPType: to.Ptr(armkusto.PublicIPTypeDualStack),
	// 			PublicNetworkAccess: to.Ptr(armkusto.PublicNetworkAccessEnabled),
	// 			RestrictOutboundNetworkAccess: to.Ptr(armkusto.ClusterNetworkAccessFlagDisabled),
	// 		},
	// 		SKU: &armkusto.AzureSKU{
	// 			Name: to.Ptr(armkusto.AzureSKUNameStandardL16AsV3),
	// 			Capacity: to.Ptr[int32](2),
	// 			Tier: to.Ptr(armkusto.AzureSKUTierStandard),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { KustoManagementClient } = require("@azure/arm-kusto");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Create or update a Kusto cluster.
 *
 * @summary Create or update a Kusto cluster.
 * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoClustersCreateOrUpdate.json
 */
async function kustoClustersCreateOrUpdate() {
  const subscriptionId =
    process.env["KUSTO_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-123456789098";
  const resourceGroupName = process.env["KUSTO_RESOURCE_GROUP"] || "kustorptest";
  const clusterName = "kustoCluster";
  const parameters = {
    allowedIpRangeList: ["0.0.0.0/0"],
    enableAutoStop: true,
    enableDoubleEncryption: false,
    enablePurge: true,
    enableStreamingIngest: true,
    identity: { type: "SystemAssigned" },
    languageExtensions: {
      value: [
        {
          languageExtensionImageName: "Python3_10_8",
          languageExtensionName: "PYTHON",
        },
        { languageExtensionImageName: "R", languageExtensionName: "R" },
      ],
    },
    location: "westus",
    publicIPType: "DualStack",
    publicNetworkAccess: "Enabled",
    sku: { name: "Standard_L16as_v3", capacity: 2, tier: "Standard" },
  };
  const credential = new DefaultAzureCredential();
  const client = new KustoManagementClient(credential, subscriptionId);
  const result = await client.clusters.beginCreateOrUpdateAndWait(
    resourceGroupName,
    clusterName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Kusto.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Kusto;

// Generated from example definition: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoClustersCreateOrUpdate.json
// this example is just showing the usage of "Clusters_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "12345678-1234-1234-1234-123456789098";
string resourceGroupName = "kustorptest";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this KustoClusterResource
KustoClusterCollection collection = resourceGroupResource.GetKustoClusters();

// invoke the operation
string clusterName = "kustoCluster";
KustoClusterData data = new KustoClusterData(new AzureLocation("westus"), new KustoSku(KustoSkuName.StandardL16asV3, KustoSkuTier.Standard)
{
    Capacity = 2,
})
{
    Identity = new ManagedServiceIdentity("SystemAssigned"),
    IsStreamingIngestEnabled = true,
    IsPurgeEnabled = true,
    LanguageExtensionsValue = {new KustoLanguageExtension
    {
    LanguageExtensionName = KustoLanguageExtensionName.Python,
    LanguageExtensionImageName = KustoLanguageExtensionImageName.Python3_10_8,
    }, new KustoLanguageExtension
    {
    LanguageExtensionName = KustoLanguageExtensionName.R,
    LanguageExtensionImageName = KustoLanguageExtensionImageName.R,
    }},
    IsDoubleEncryptionEnabled = false,
    PublicNetworkAccess = KustoClusterPublicNetworkAccess.Enabled,
    AllowedIPRangeList = { "0.0.0.0/0" },
    IsAutoStopEnabled = true,
    PublicIPType = KustoClusterPublicIPType.DualStack,
};
ArmOperation<KustoClusterResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, clusterName, data);
KustoClusterResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
KustoClusterData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

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

定義

名稱	Description
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	表示叢集信任的租用戶標識碼。
UserAssignedIdentities	與 Kusto 叢集相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
VirtualNetworkConfiguration	包含虛擬網路定義的類別。
VnetState	啟用時，叢集會部署到已設定的子網中，當停用時，叢集將會從子網中移除。
ZoneStatus	指出叢集是區域性還是非區域。

AcceptedAudiences

Object

表示叢集信任的接受物件。

名稱	類型	Description
value	string	代表接受物件的 GUID 或有效 URL。

AzureSku

Object

Azure SKU 定義。

名稱	類型	Description
capacity	integer (int32)	叢集實例的數目。
name	AzureSkuName	SKU 名稱。
tier	AzureSkuTier	SKU 層。

AzureSkuName

列舉型別

SKU 名稱。

值	Description
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_D16d_v5
Standard_D32d_v4
Standard_D32d_v5
Standard_DS13_v2+1TB_PS
Standard_DS13_v2+2TB_PS
Standard_DS14_v2+3TB_PS
Standard_DS14_v2+4TB_PS
Standard_E16a_v4
Standard_E16ads_v5
Standard_E16as_v4+3TB_PS
Standard_E16as_v4+4TB_PS
Standard_E16as_v5+3TB_PS
Standard_E16as_v5+4TB_PS
Standard_E16d_v4
Standard_E16d_v5
Standard_E16s_v4+3TB_PS
Standard_E16s_v4+4TB_PS
Standard_E16s_v5+3TB_PS
Standard_E16s_v5+4TB_PS
Standard_E2a_v4
Standard_E2ads_v5
Standard_E2d_v4
Standard_E2d_v5
Standard_E4a_v4
Standard_E4ads_v5
Standard_E4d_v4
Standard_E4d_v5
Standard_E64i_v3
Standard_E80ids_v4
Standard_E8a_v4
Standard_E8ads_v5
Standard_E8as_v4+1TB_PS
Standard_E8as_v4+2TB_PS
Standard_E8as_v5+1TB_PS
Standard_E8as_v5+2TB_PS
Standard_E8d_v4
Standard_E8d_v5
Standard_E8s_v4+1TB_PS
Standard_E8s_v4+2TB_PS
Standard_E8s_v5+1TB_PS
Standard_E8s_v5+2TB_PS
Standard_EC16ads_v5
Standard_EC16as_v5+3TB_PS
Standard_EC16as_v5+4TB_PS
Standard_EC8ads_v5
Standard_EC8as_v5+1TB_PS
Standard_EC8as_v5+2TB_PS
Standard_L16as_v3
Standard_L16s
Standard_L16s_v2
Standard_L16s_v3
Standard_L32as_v3
Standard_L32s_v3
Standard_L4s
Standard_L8as_v3
Standard_L8s
Standard_L8s_v2
Standard_L8s_v3

AzureSkuTier

列舉型別

SKU 層。

值	Description
Basic
Standard

CalloutPolicy

Object

外部註標原則的設定，包括 URI 模式、存取類型和服務類型。

名稱	類型	Description
calloutId	string	圖說文字組態的唯一標識符。
calloutType	calloutType	圖說文字服務的型別，指定要存取的外部資源或服務類型。
calloutUriRegex	string	註標 URI 的正規表示式或 FQDN 模式。
outboundAccess	outboundAccess	指出是否允許指定 URI 模式的輸出存取。

calloutType

列舉型別

圖說文字服務的型別，指定要存取的外部資源或服務類型。

值	Description
azure_digital_twins
azure_openai
cosmosdb
external_data
genevametrics
kusto
mysql
postgresql
sandbox_artifacts
sql
webapi

Cluster

Object

代表 Kusto 叢集的類別。

名稱	類型	預設值	Description
etag	string		每當更新資源時變更的唯一隻讀字串。
id	string		資源的完整資源標識碼。 例如 - /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'

值	Description
Disabled
Enabled

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

EngineType

列舉型別

引擎類型

值	Description
V2
V3

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

Identity

Object

資源的身分識別。

名稱	類型	Description
principalId	string	資源識別的主要標識碼。
tenantId	string	資源的租用戶標識碼。
type	IdentityType	所使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會移除所有身分識別。
userAssignedIdentities	UserAssignedIdentities	與 Kusto 叢集相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

IdentityType

列舉型別

所使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會移除所有身分識別。

值	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

KeyVaultProperties

Object

金鑰保存庫的屬性。

名稱	類型	Description
keyName	string	金鑰儲存庫金鑰的名稱。
keyVaultUri	string	金鑰保存庫的 URI。
keyVersion	string	金鑰儲存庫金鑰的版本。
userIdentity	string	使用者指派的身分識別 （ARM 資源識別碼） 可存取金鑰。

LanguageExtension

Object

語言延伸物件。

名稱	類型	Description
languageExtensionCustomImageName	string	語言延伸模組自定義映像名稱。
languageExtensionImageName	languageExtensionImageName	語言延伸模組映像名稱。
languageExtensionName	languageExtensionName	語言延伸模組名稱。

languageExtensionImageName

列舉型別

語言延伸模組映像名稱。

值	Description
Python3_10_8
Python3_10_8_DL
Python3_11_7
Python3_11_7_DL
Python3_6_5
PythonCustomImage
R

languageExtensionName

列舉型別

語言延伸模組名稱。

值	Description
PYTHON
R

LanguageExtensionsList

Object

語言延伸模組對象的清單。

名稱	類型	Description
value	LanguageExtension[]	語言延伸模組的清單。

MigrationClusterProperties

Object

表示屬於移轉一部分之叢集的屬性。

名稱	類型	Description
dataIngestionUri	string	叢集的公用數據擷取 URL。
id	string	叢集的資源標識碼。
role	MigrationClusterRole	叢集在移轉程式中的角色。
uri	string	叢集的公用 URL。

MigrationClusterRole

列舉型別

叢集在移轉程式中的角色。

值	Description
Destination
Source

OptimizedAutoscale

Object

類別，包含優化的自動調整定義。

名稱	類型	Description
isEnabled	boolean	布爾值，指出優化自動調整功能是否已啟用。
maximum	integer (int32)	允許的實例計數上限。
minimum	integer (int32)	允許的實例計數下限。
version	integer (int32)	定義的範本版本，例如 1。

outboundAccess

列舉型別

指出是否允許指定 URI 模式的輸出存取。

值	Description
Allow
Deny

PrivateEndpointConnection

Object

私人端點連線

名稱	類型	Description
id	string	資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.groupId	string	私人端點的群組標識碼。
properties.privateEndpoint	PrivateEndpointProperty	線上所屬的私人端點。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	私人端點連線的連接狀態。
properties.provisioningState	string	布建私人端點的狀態。
systemData	systemData	與建立和上次修改資源相關的元數據。
type	string	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointProperty

Object

線上所屬的私人端點。

名稱	類型	Description
id	string	私人端點的資源標識碼。

PrivateLinkServiceConnectionStateProperty

Object

私人端點連線的連接狀態。

名稱	類型	Description
actionsRequired	string	基本工作流程以外的任何必要動作（核准/拒絕/中斷連線）
description	string	私人鏈接服務連線描述。
status	string	私人鏈接服務連線狀態。

ProvisioningState

列舉型別

資源的布建狀態。

值	Description
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded

publicIPType

列舉型別

指出要建立的公用IP類型 - IPv4 （預設值），或 DualStack （IPv4 和 IPv6）

值	Description
DualStack
IPv4

PublicNetworkAccess

列舉型別

默認會啟用叢集的公用網路存取。 停用時，只允許與叢集的私人端點連線

值	Description
Disabled
Enabled

State

列舉型別

資源的狀態。

值	Description
Creating
Deleted
Deleting
Migrated
Running
Starting
Stopped
Stopping
Unavailable
Updating

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

TrustedExternalTenant

Object

表示叢集信任的租用戶標識碼。

名稱	類型	Description
value	string	代表外部租使用者的 GUID。

UserAssignedIdentities

Object

與 Kusto 叢集相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

名稱	類型	Description

VirtualNetworkConfiguration

Object

包含虛擬網路定義的類別。

名稱	類型	預設值	Description
dataManagementPublicIpId	string		數據管理的服務公用IP位址資源標識碼。
enginePublicIpId	string		引擎服務的公用IP位址資源標識碼。
state	VnetState	Enabled	啟用時，叢集會部署到已設定的子網中，當停用時，叢集將會從子網中移除。
subnetId	string		子網資源標識碼。

VnetState

列舉型別

啟用時，叢集會部署到已設定的子網中，當停用時，叢集將會從子網中移除。

值	Description
Disabled
Enabled

ZoneStatus

列舉型別

指出叢集是區域性還是非區域。

值	Description
NonZonal
Zonal
ZonalInconsistency