Clusters - Create Or Update

Dienst:

AVS

API-Version:

2024-09-01

Erstellen eines Clusters

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterName	path	True	string pattern: ^[-\w\._]+$	Name des Clusters
privateCloudName	path	True	string pattern: ^[-\w\._]+$	Name der privaten Cloud
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
sku	True	Sku	Die dieser Ressource zugeordnete SKU (Lagerhaltungseinheit).
properties.clusterSize		integer (int32)	Die Clustergröße
properties.hosts		string[]	Die Hosts
properties.vsanDatastoreName		string	Name des vsan-Datenspeichers, der dem Cluster zugeordnet ist

Antworten

Name	Typ	Beschreibung
200 OK	Cluster	Der Aktualisierungsvorgang der Ressource "Cluster" war erfolgreich.
201 Created	Cluster	Der Vorgang zum Erstellen der Ressource "Cluster" war erfolgreich. Header Retry-After: integer
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Clusters_CreateOrUpdate

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

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

Definitionen

Name	Beschreibung
Cluster	Eine Clusterressource
ClusterProvisioningState	Clusterbereitstellungsstatus
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
Sku	Die Definition des Ressourcenmodells, die SKU darstellt
SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

Cluster

Objekt

Eine Clusterressource

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.clusterId	integer (int32)	Die Identität
properties.clusterSize	integer (int32)	Die Clustergröße
properties.hosts	string[]	Die Hosts
properties.provisioningState	ClusterProvisioningState	Der Status der Clusterbereitstellung
properties.vsanDatastoreName	string	Name des vsan-Datenspeichers, der dem Cluster zugeordnet ist
sku	Sku	Die dieser Ressource zugeordnete SKU (Lagerhaltungseinheit).
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ClusterProvisioningState

Enumeration

Clusterbereitstellungsstatus

Wert	Beschreibung
Canceled	Die Ressourcenerstellung wurde abgebrochen.
Cancelled	wird abgebrochen.
Deleting	Löscht
Failed	Fehler bei der Ressourcenerstellung.
Succeeded	Ressource wurde erstellt.
Updating	wird aktualisiert.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Sku

Objekt

Die Definition des Ressourcenmodells, die SKU darstellt

Name	Typ	Beschreibung
capacity	integer (int32)	Wenn die SKU skalierungs-/in unterstützt, sollte die Ganze Kapazität eingeschlossen werden. Wenn eine Skalierung für die Ressource nicht möglich ist, wird dies möglicherweise weggelassen.
family	string	Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden.
name	string	Der Name der SKU. Z.B. P3. Es handelt sich in der Regel um einen Buchstaben+Zahlencode.
size	string	Die SKU-Größe. Wenn das Namensfeld die Kombination aus Ebene und einem anderen Wert ist, wäre dies der eigenständige Code.
tier	SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.

SkuTier

Enumeration

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.

Wert	Beschreibung
Basic
Free
Premium
Standard

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.