Clusters - Create Or Update

Szolgáltatás:

AVS

API verzió:

2025-09-01

Klaszter létrehozása

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}?api-version=2025-09-01

URI paraméterek

Név	Ban	Szükséges	Típus	Leírás
clusterName	path	True	string pattern: ^[-\w\._]+$	A klaszter neve
privateCloudName	path	True	string pattern: ^[-\w\._]+$	A magánfelhő neve
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérő Testület

Név	Szükséges	Típus	Leírás
sku	True	Sku	Az erőforráshoz rendelt termékváltozat (készletmegőrzési egység).
properties.clusterSize		integer (int32)	A fürt mérete
properties.hosts		string[]	A gazdagépek
properties.vsanDatastoreName		string	A fürthöz társított vsan-adattár neve

Válaszok

Név	Típus	Leírás
200 OK	Cluster	Az erőforrás "fürt" frissítési művelete sikeres volt
201 Created	Cluster	A "Fürt" erőforrás létrehozási művelete sikeres volt Fejlécek Retry-After: integer
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Flow: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Név	Leírás
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Clusters_CreateOrUpdate

Mintakérés

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1?api-version=2025-09-01

{
  "sku": {
    "name": "AV20"
  },
  "properties": {
    "clusterSize": 3
  }
}

Java

import com.azure.resourcemanager.avs.models.Sku;

/**
 * Samples for Clusters CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-09-01/Clusters_CreateOrUpdate.json
     */
    /**
     * Sample code: Clusters_CreateOrUpdate.
     * 
     * @param manager Entry point to AvsManager.
     */
    public static void clustersCreateOrUpdate(com.azure.resourcemanager.avs.AvsManager manager) {
        manager.clusters().define("cluster1").withExistingPrivateCloud("group1", "cloud1")
            .withSku(new Sku().withName("AV20")).withClusterSize(3).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.avs import AVSClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-avs
# USAGE
    python 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 = AVSClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.clusters.begin_create_or_update(
        resource_group_name="group1",
        private_cloud_name="cloud1",
        cluster_name="cluster1",
        cluster={"properties": {"clusterSize": 3}, "sku": {"name": "AV20"}},
    ).result()
    print(response)


# x-ms-original-file: 2025-09-01/Clusters_CreateOrUpdate.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 armavs_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/avs/armavs/v2"
)

// Generated from example definition: 2025-09-01/Clusters_CreateOrUpdate.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 := armavs.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClustersClient().BeginCreateOrUpdate(ctx, "group1", "cloud1", "cluster1", armavs.Cluster{
		SKU: &armavs.SKU{
			Name: to.Ptr("AV20"),
		},
		Properties: &armavs.ClusterProperties{
			ClusterSize: to.Ptr[int32](3),
		},
	}, 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 = armavs.ClustersClientCreateOrUpdateResponse{
	// 	Cluster: &armavs.Cluster{
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1"),
	// 		Name: to.Ptr("cluster1"),
	// 		SKU: &armavs.SKU{
	// 			Name: to.Ptr("AV20"),
	// 		},
	// 		Properties: &armavs.ClusterProperties{
	// 			ClusterSize: to.Ptr[int32](3),
	// 			Hosts: []*string{
	// 				to.Ptr("fakehost22.nyc1.kubernetes.center"),
	// 				to.Ptr("fakehost23.nyc1.kubernetes.center"),
	// 				to.Ptr("fakehost24.nyc1.kubernetes.center"),
	// 			},
	// 			ProvisioningState: to.Ptr(armavs.ClusterProvisioningStateSucceeded),
	// 		},
	// 		Type: to.Ptr("Microsoft.AVS/privateClouds/clusters"),
	// 	},
	// }
}

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 { AzureVMwareSolutionAPI } = require("@azure/arm-avs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create a Cluster
 *
 * @summary create a Cluster
 * x-ms-original-file: 2025-09-01/Clusters_CreateOrUpdate.json
 */
async function clustersCreateOrUpdate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new AzureVMwareSolutionAPI(credential, subscriptionId);
  const result = await client.clusters.createOrUpdate("group1", "cloud1", "cluster1", {
    sku: { name: "AV20" },
    properties: { clusterSize: 3 },
  });
  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

Mintaválasz

Állapotkód:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1",
  "name": "cluster1",
  "sku": {
    "name": "AV20"
  },
  "properties": {
    "clusterSize": 3,
    "hosts": [
      "fakehost22.nyc1.kubernetes.center",
      "fakehost23.nyc1.kubernetes.center",
      "fakehost24.nyc1.kubernetes.center"
    ],
    "provisioningState": "Succeeded"
  },
  "type": "Microsoft.AVS/privateClouds/clusters"
}

Állapotkód:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1",
  "name": "cluster1",
  "sku": {
    "name": "AV20"
  },
  "properties": {
    "clusterSize": 3,
    "provisioningState": "Updating"
  },
  "type": "Microsoft.AVS/privateClouds/clusters"
}

Meghatározások

Név	Leírás
Cluster	Egy klasztererőforrás
ClusterProvisioningState	Klaszter provisioning állapot
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
Sku	A termékváltozatot képviselő erőforrásmodell-definíció
SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Cluster

Tárgy

Egy klasztererőforrás

Név	Típus	Leírás
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Az erőforrás neve
properties.clusterId	integer (int32)	Az identitás
properties.clusterSize	integer (int32)	A fürt mérete
properties.hosts	string[]	A gazdagépek
properties.provisioningState	ClusterProvisioningState	A klaszter-provisioning állapota
properties.vsanDatastoreName	string	A fürthöz társított vsan-adattár neve
sku	Sku	Az erőforráshoz rendelt termékváltozat (készletmegőrzési egység).
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ClusterProvisioningState

Felsorolás

Klaszter provisioning állapot

Érték	Leírás
Succeeded	Az erőforrás létrejött.
Failed	Az erőforrás létrehozása nem sikerült.
Canceled	Az erőforrás létrehozása megszakadt.
Cancelled	törölve van
Deleting	törlés
Updating	frissít

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Leírás
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Név	Típus	Leírás
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Név	Típus	Leírás
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Tárgy

Hibaválasz

Név	Típus	Leírás
error	ErrorDetail	A hibaobjektum.

Sku

Tárgy

A termékváltozatot képviselő erőforrásmodell-definíció

Név	Típus	Leírás
capacity	integer (int32)	Ha az SKU támogatja a vertikális felskálázást/azt, akkor a kapacitás egészét is tartalmaznia kell. Ha az erőforrás esetében nem lehetséges a vertikális felskálázás/beskálázás, akkor ez kihagyható.
family	string	Ha a szolgáltatás különböző hardvergenerációval rendelkezik ugyanahhoz az SKU-hoz, akkor ezt itt rögzítheti.
name	string	Az termékváltozat neve. Pl. P3. Ez általában egy betű+szám kód
size	string	A termékváltozat mérete. Ha a névmező a réteg és más értékek kombinációja, akkor ez a különálló kód.
tier	SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

SkuTier

Felsorolás

Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

Érték	Leírás
Free
Basic
Standard
Premium

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Név	Típus	Leírás
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.