Snapshots - Update Tags

Servicio:

AKS

Versión de la API:

2026-03-01

Actualiza las etiquetas en una instantánea.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
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]$	El nombre del recurso de clúster administrado.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
tags	object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	Snapshot	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Update Snapshot Tags

Solicitud de ejemplo

HTTP

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

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

Java

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-03-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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

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

    response = client.snapshots.update_tags(
        resource_group_name="rg1",
        resource_name="snapshot1",
        parameters={"tags": {"key2": "new-val2", "key3": "val3"}},
    )
    print(response)


# x-ms-original-file: 2026-03-01/SnapshotsUpdateTags.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 armcontainerservice_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/containerservice/armcontainerservice/v9"
)

// Generated from example definition: 2026-03-01/SnapshotsUpdateTags.json
func ExampleSnapshotsClient_UpdateTags() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSnapshotsClient().UpdateTags(ctx, "rg1", "snapshot1", armcontainerservice.TagsObject{
		Tags: map[string]*string{
			"key2": to.Ptr("new-val2"),
			"key3": to.Ptr("val3"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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 = armcontainerservice.SnapshotsClientUpdateTagsResponse{
	// 	Snapshot: armcontainerservice.Snapshot{
	// 		Name: to.Ptr("snapshot1"),
	// 		Type: to.Ptr("Microsoft.ContainerService/snapshots"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"),
	// 		Location: to.Ptr("westus"),
	// 		Properties: &armcontainerservice.SnapshotProperties{
	// 			CreationData: &armcontainerservice.CreationData{
	// 				SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"),
	// 			},
	// 			EnableFIPS: to.Ptr(false),
	// 			KubernetesVersion: to.Ptr("1.20.5"),
	// 			NodeImageVersion: to.Ptr("AKSUbuntu-1804gen2containerd-2021.09.11"),
	// 			OSSKU: to.Ptr(armcontainerservice.OSSKUUbuntu),
	// 			OSType: to.Ptr(armcontainerservice.OSTypeLinux),
	// 			SnapshotType: to.Ptr(armcontainerservice.SnapshotTypeNodePool),
	// 			VMSize: to.Ptr("Standard_D2s_v3"),
	// 		},
	// 		SystemData: &armcontainerservice.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-09T20:13:23.298420761Z"); return t}()),
	// 			CreatedBy: to.Ptr("user1"),
	// 			CreatedByType: to.Ptr(armcontainerservice.CreatedByTypeUser),
	// 		},
	// 		Tags: map[string]*string{
	// 			"key2": to.Ptr("new-val2"),
	// 			"key3": to.Ptr("val3"),
	// 		},
	// 	},
	// }
}

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 { 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-03-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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
CreationData	Datos usados al crear un recurso de destino a partir de un recurso de origen.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
OSSKU	Especifica la SKU del sistema operativo utilizada por el grupo de agentes. El valor predeterminado es Ubuntu si OSType es Linux. El valor predeterminado es Windows2019 cuando Kubernetes <= 1.24 o Windows2022 cuando Kubernetes >= 1.25 si OSType es Windows.
OSType	Tipo de sistema operativo. El valor predeterminado es Linux.
Snapshot	Un recurso de instantánea del grupo de nodos.
SnapshotType	Tipo de una instantánea. El valor predeterminado es NodePool.
systemData	Metadatos relativos a la creación y última modificación del recurso.
TagsObject	Objeto Tags para operaciones de revisión.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

CreationData

Objeto

Datos usados al crear un recurso de destino a partir de un recurso de origen.

Nombre	Tipo	Description
sourceResourceId	string (arm-id)	Este es el identificador de ARM del objeto de origen que se va a usar para crear el objeto de destino.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

OSSKU

Enumeración

Especifica la SKU del sistema operativo utilizada por el grupo de agentes. El valor predeterminado es Ubuntu si OSType es Linux. El valor predeterminado es Windows2019 cuando Kubernetes <= 1.24 o Windows2022 cuando Kubernetes >= 1.25 si OSType es Windows.

Valor	Description
Ubuntu	Use Ubuntu como sistema operativo para imágenes de nodo.
AzureLinux	Use AzureLinux como sistema operativo para imágenes de nodo. Azure Linux es una distribución linux optimizada para contenedores creada por Microsoft, visite https://aka.ms/azurelinux para obtener más información.
AzureLinux3	Use AzureLinux3 como sistema operativo para las imágenes de nodo. Azure Linux es una distribución linux optimizada para contenedores creada por Microsoft, visite https://aka.ms/azurelinux para obtener más información. Para conocer las limitaciones, visite https://aka.ms/aks/node-images. Para obtener instrucciones sobre la migración del sistema operativo, consulte https://aka.ms/aks/upgrade-os-version.
CBLMariner	OSSKU en desuso. Microsoft recomienda que las nuevas implementaciones elijan "AzureLinux" en su lugar.
Windows2019	Use Windows2019 como sistema operativo para imágenes de nodo. No se admite para los grupos de nodos del sistema. Windows2019 solo admite contenedores de Windows2019; no puede ejecutar contenedores de Windows2022 y viceversa.
Windows2022	Use Windows2022 como sistema operativo para imágenes de nodo. No se admite para los grupos de nodos del sistema. Windows2022 solo admite contenedores de Windows2022; no puede ejecutar contenedores de Windows2019 y viceversa.
Ubuntu2204	Utilice Ubuntu2204 como sistema operativo para las imágenes de nodo, sin embargo, es posible que Ubuntu 22.04 no sea compatible con todos los grupos de nodos. Para conocer las limitaciones y las versiones de Kubernetes compatibles, consulte https://aka.ms/aks/supported-ubuntu-versions
Windows2025	Utilice Windows2025 como sistema operativo para las imágenes de nodo. No se admite para los grupos de nodos del sistema. Windows2025 es compatible con contenedores Windows2022 y Windows 2025; no puede ejecutar contenedores Windows2019 y viceversa.
Ubuntu2404	Use Ubuntu2404 como sistema operativo para las imágenes de nodo, sin embargo, es posible que Ubuntu 24.04 no sea compatible con todos los grupos de nodos. Para conocer las limitaciones y las versiones de Kubernetes compatibles, consulte https://aka.ms/aks/supported-ubuntu-versions
AzureContainerLinux	Usa Azure Container Linux como sistema operativo para las imágenes de los nodos. Azure Container Linux es un sistema operativo Linux optimizado para contenedores y centrado en la seguridad, construido sobre Azure Linux, con un sistema de archivos inmutable. ACL deriva del proyecto Flatcar Container Linux, basándose en el probado diseño inmutable basado en contenedores de Flatcar, mientras añade paquetes Linux de Azure, servicio y una integración profunda con el ciclo de vida de Azure y AKS. Para obtener más información, consulte: https://aka.ms/azurecontainerlinux

OSType

Enumeración

Tipo de sistema operativo. El valor predeterminado es Linux.

Valor	Description
Linux	Usa Linux.
Windows	Usa Windows.

Snapshot

Objeto

Un recurso de instantánea del grupo de nodos.

Nombre	Tipo	Valor predeterminado	Description
id	string (arm-id)		Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		Ubicación geográfica donde reside el recurso
name	string		Nombre del recurso
properties.creationData	CreationData		CreationData que se usará para especificar el identificador de recurso del grupo de agentes de origen para crear esta instantánea.
properties.enableFIPS	boolean		Si se usa un sistema operativo habilitado para FIPS.
properties.kubernetesVersion	string		Versión de Kubernetes.
properties.nodeImageVersion	string		Versión de la imagen de nodo.
properties.osSku	OSSKU		Especifica la SKU del sistema operativo utilizada por el grupo de agentes. El valor predeterminado es Ubuntu si OSType es Linux. El valor predeterminado es Windows2019 cuando Kubernetes <= 1.24 o Windows2022 cuando Kubernetes >= 1.25 si OSType es Windows.
properties.osType	OSType	Linux	Tipo de sistema operativo. El valor predeterminado es Linux.
properties.snapshotType	SnapshotType	NodePool	Tipo de una instantánea. El valor predeterminado es NodePool.
properties.vmSize	string		Tamaño de la máquina virtual.
systemData	systemData		Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
tags	object		Etiquetas de recursos.
type	string		Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SnapshotType

Enumeración

Tipo de una instantánea. El valor predeterminado es NodePool.

Valor	Description
NodePool	La instantánea es una instantánea de un grupo de nodos.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TagsObject

Objeto

Objeto Tags para operaciones de revisión.

Nombre	Tipo	Description
tags	object	Etiquetas de recursos.