Snapshots - Update Tags

Referenz

Dienst:: AKS

API-Version:: 2025-04-01

Aktualisiert Tags in einer Momentaufnahme.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}?api-version=2025-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$	Der Name der verwalteten Clusterressource.
subscriptionId	path	True	string (uuid)	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
tags	object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	Snapshot	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

Update Snapshot Tags

Beispielanforderung

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1?api-version=2025-04-01

{
  "tags": {
    "key2": "new-val2",
    "key3": "val3"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "snapshot1",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1",
  "type": "Microsoft.ContainerService/Snapshots",
  "location": "westus",
  "tags": {
    "key1": "val1",
    "key2": "val2"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-08-09T20:13:23.298420761Z"
  },
  "properties": {
    "creationData": {
      "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"
    },
    "snapshotType": "NodePool",
    "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11",
    "kubernetesVersion": "1.20.5",
    "osType": "Linux",
    "osSku": "Ubuntu",
    "vmSize": "Standard_D2s_v3",
    "enableFIPS": false
  }
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Containerdiensts.
CloudErrorBody	Eine Fehlerantwort des Containerdiensts.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CreationData	Daten, die beim Erstellen einer Zielressource aus einer Quellressource verwendet werden.
OSSKU	Gibt die vom Agentpool verwendete Betriebssystem-SKU an. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Der Standardwert ist Windows2019, wenn Kubernetes <= 1.24 oder Windows2022, wenn Kubernetes >= 1.25 ist, wenn OSType Windows ist.
OSType	Der Betriebssystemtyp. Der Standardwert ist Linux.
Snapshot	Eine Momentaufnahmeressource des Knotenpools.
SnapshotType	Der Typ einer Momentaufnahme. Der Standardwert ist NodePool.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TagsObject	Tags-Objekt für Patchvorgänge.

CloudError

Objekt

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Details zum Fehler.

CloudErrorBody

Objekt

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

CreationData

Objekt

Daten, die beim Erstellen einer Zielressource aus einer Quellressource verwendet werden.

Name	Typ	Beschreibung
sourceResourceId	string (arm-id)	Dies ist die ARM-ID des Quellobjekts, das zum Erstellen des Zielobjekts verwendet werden soll.

OSSKU

Enumeration

Gibt die vom Agentpool verwendete Betriebssystem-SKU an. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Der Standardwert ist Windows2019, wenn Kubernetes <= 1.24 oder Windows2022, wenn Kubernetes >= 1.25 ist, wenn OSType Windows ist.

Wert	Beschreibung
AzureLinux	Verwenden Sie AzureLinux als Betriebssystem für Knotenimages. Azure Linux ist eine containeroptimierte Linux-Distribution, die von Microsoft erstellt wurde, besuchen Sie https://aka.ms/azurelinux, um weitere Informationen zu finden.
CBLMariner	Veraltete OSSKU. Microsoft empfiehlt, stattdessen neue Bereitstellungen "AzureLinux" auszuwählen.
Ubuntu	Verwenden Sie Ubuntu als Betriebssystem für Knotenimages.
Ubuntu2204	Verwenden Sie Ubuntu2204 als Betriebssystem für Knotenimages, Ubuntu 22.04 wird jedoch möglicherweise nicht für alle Knotenpools unterstützt. Informationen zu Einschränkungen und unterstützten Kubernetes-Versionen finden Sie unter https://aka.ms/aks/supported-ubuntu-versions
Windows2019	Verwenden Sie Windows2019 als Betriebssystem für Knotenimages. Nicht unterstützt für Systemknotenpools. Windows2019 unterstützt nur Windows2019-Container; Sie kann Keine Windows2022-Container ausführen und umgekehrt.
Windows2022	Verwenden Sie Windows2022 als Betriebssystem für Knotenimages. Nicht unterstützt für Systemknotenpools. Windows2022 unterstützt nur Windows2022-Container; Sie kann Keine Windows2019-Container ausführen und umgekehrt.

OSType

Enumeration

Der Betriebssystemtyp. Der Standardwert ist Linux.

Wert	Beschreibung
Linux	Verwenden Sie Linux.
Windows	Verwenden Sie Windows.

Snapshot

Objekt

Eine Momentaufnahmeressource des Knotenpools.

Name	Typ	Standardwert	Beschreibung
id	string (arm-id)		Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		Der geografische Standort, an dem sich die Ressource befindet
name	string		Der Name der Ressource
properties.creationData	CreationData		CreationData, die verwendet werden soll, um die Ressourcen-ID des Quell-Agent-Pools anzugeben, um diese Momentaufnahme zu erstellen.
properties.enableFIPS	boolean		Gibt an, ob ein FIPS-fähiges Betriebssystem verwendet werden soll.
properties.kubernetesVersion	string		Die Version von Kubernetes.
properties.nodeImageVersion	string		Die Version des Knotenimages.
properties.osSku	OSSKU		Gibt die vom Agentpool verwendete Betriebssystem-SKU an. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Der Standardwert ist Windows2019, wenn Kubernetes <= 1.24 oder Windows2022, wenn Kubernetes >= 1.25 ist, wenn OSType Windows ist.
properties.osType	OSType	Linux	Der Betriebssystemtyp. Der Standardwert ist Linux.
properties.snapshotType	SnapshotType	NodePool	Der Typ einer Momentaufnahme. Der Standardwert ist NodePool.
properties.vmSize	string		Die Größe des virtuellen Computers.
systemData	systemData		Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object		Ressourcentags.
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SnapshotType

Enumeration

Der Typ einer Momentaufnahme. Der Standardwert ist NodePool.

Wert	Beschreibung
NodePool	Die Momentaufnahme ist eine Momentaufnahme eines Knotenpools.

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.

TagsObject

Objekt

Tags-Objekt für Patchvorgänge.

Name	Typ	Beschreibung
tags	object	Ressourcentags.

Freigeben über

Snapshots - Update Tags

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Update Snapshot Tags

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

CloudErrorBody

createdByType

CreationData

OSSKU

OSType

Snapshot

SnapshotType

systemData

TagsObject