Snapshots - Update Tags

Dienst:: AKS

API-Version:: 2026-02-01

Aktualisiert Tags in einem Snapshot.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}?api-version=2026-02-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)	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	Typ	Beschreibung
tags	object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	Snapshot	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

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

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


import com.azure.resourcemanager.containerservice.models.TagsObject;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Snapshots UpdateTags.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-02-01/SnapshotsUpdateTags.json
     */
    /**
     * Sample code: Update Snapshot Tags.
     * 
     * @param manager Entry point to ContainerServiceManager.
     */
    public static void updateSnapshotTags(com.azure.resourcemanager.containerservice.ContainerServiceManager manager) {
        manager.serviceClient().getSnapshots().updateTagsWithResponse("rg1", "snapshot1",
            new TagsObject().withTags(mapOf("key2", "fakeTokenPlaceholder", "key3", "fakeTokenPlaceholder")),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

const { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to updates tags on a snapshot.
 *
 * @summary updates tags on a snapshot.
 * x-ms-original-file: 2026-02-01/SnapshotsUpdateTags.json
 */
async function updateSnapshotTags() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.snapshots.updateTags("rg1", "snapshot1", {
    tags: { key2: "new-val2", key3: "val3" },
  });
  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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CreationData	Daten, die beim Erstellen einer Zielressource aus einer Quellressource verwendet werden.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
OSSKU	Gibt die vom Agentpool verwendete Betriebssystem-SKU an. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Standardmäßig ist Windows 2019, wenn Kubernetes <= 1.24 verwendet wird, oder Windows2022, wenn Kubernetes >= 1.25, 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.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

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.

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.

OSSKU

Enumeration

Gibt die vom Agentpool verwendete Betriebssystem-SKU an. Der Standardwert ist Ubuntu, wenn OSType Linux ist. Standardmäßig ist Windows 2019, wenn Kubernetes <= 1.24 verwendet wird, oder Windows2022, wenn Kubernetes >= 1.25, wenn OSType Windows ist.

Wert	Beschreibung
Ubuntu	Verwenden Sie Ubuntu als Betriebssystem für Knotenimages.
AzureLinux	Verwenden Sie AzureLinux als Betriebssystem für Knotenimages. Azure Linux eine containeroptimierte Linux-Distribution ist, die von Microsoft entwickelt wurde, besuchen Sie https://aka.ms/azurelinux für weitere Informationen.
AzureLinux3	Verwenden Sie AzureLinux3 als Betriebssystem für Knotenimages. Azure Linux eine containeroptimierte Linux-Distribution ist, die von Microsoft entwickelt wurde, besuchen Sie https://aka.ms/azurelinux für weitere Informationen. Informationen zu Einschränkungen finden Sie unter https://aka.ms/aks/node-images. Eine Anleitung zur Betriebssystemmigration finden Sie unter https://aka.ms/aks/upgrade-os-version.
CBLMariner	Veraltete OSSKU. Microsoft empfiehlt, dass neue Bereitstellungen stattdessen 'AzureLinux' wählen.
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.
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
Windows2025	Verwenden Sie Windows2025 als Betriebssystem für Knotenimages. Nicht unterstützt für Systemknotenpools. Windows2025 unterstützt Windows2022- und Windows 2025-Container; es kann keine Windows2019-Container ausführen und umgekehrt.
Ubuntu2404	Verwenden Sie Ubuntu2404 als Betriebssystem für Knotenimages, Ubuntu 24.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

OSType

Enumeration

Der Betriebssystemtyp. Der Standardwert ist Linux.

Wert	Beschreibung
Linux	Verwenden Sie Linux.
Windows	Benutze 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. Standardmäßig ist Windows 2019, wenn Kubernetes <= 1.24 verwendet wird, oder Windows2022, wenn Kubernetes >= 1.25, 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. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

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.