Snapshots - Update Tags

Serviço:: AKS

Versão da API:: 2026-03-01

Atualiza tags em um instantâneo.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiú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]$	O nome do recurso de cluster gerenciado.
subscriptionId	path	True	string (uuid)	O ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
tags	object	Tags de recursos.

Respostas

Name	Tipo	Description
200 OK	Snapshot	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Update Snapshot Tags

Pedido de amostra

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


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

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

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

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

Resposta da amostra

Código de estado:: 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"
  }
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
CreationData	Dados usados ao criar um recurso de destino a partir de um recurso de origem.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
OSSKU	Especifica a SKU do sistema operacional usada pelo pool de agentes. O padrão é Ubuntu se OSType é Linux. O padrão é Windows2019 quando o Kubernetes <= 1.24 ou Windows2022 quando o Kubernetes >= 1.25 se OSType for Windows.
OSType	O tipo de sistema operacional. O padrão é Linux.
Snapshot	Um recurso de instantâneo do pool de nós.
SnapshotType	O tipo de instantâneo. O padrão é NodePool.
systemData	Metadados referentes à criação e última modificação do recurso.
TagsObject	Tags objeto para operações de patch.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

CreationData

Object

Dados usados ao criar um recurso de destino a partir de um recurso de origem.

Name	Tipo	Description
sourceResourceId	string (arm-id)	Este é o ID ARM do objeto de origem a ser usado para criar o objeto de destino.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

OSSKU

Enumeração

Especifica a SKU do sistema operacional usada pelo pool de agentes. O padrão é Ubuntu se OSType é Linux. O padrão é Windows2019 quando o Kubernetes <= 1.24 ou Windows2022 quando o Kubernetes >= 1.25 se OSType for Windows.

Valor	Description
Ubuntu	Use o Ubuntu como o sistema operacional para imagens de nós.
AzureLinux	Use AzureLinux como o sistema operacional para imagens de nó. O Azure Linux é uma distro Linux otimizada para contêiner criada pela Microsoft, visite https://aka.ms/azurelinux para obter mais informações.
AzureLinux3	Use AzureLinux3 como o sistema operacional para imagens de nó. O Azure Linux é uma distro Linux otimizada para contêiner criada pela Microsoft, visite https://aka.ms/azurelinux para obter mais informações. Para limitações, visite https://aka.ms/aks/node-images. Para obter orientações sobre migração de SO, consulte https://aka.ms/aks/upgrade-os-version.
CBLMariner	OSSKU preterido. A Microsoft recomenda que as novas implantações escolham 'AzureLinux' em vez disso.
Windows2019	Use o Windows2019 como o sistema operacional para imagens de nó. Não suportado para pools de nós do sistema. Windows2019 suporta apenas contêineres do Windows2019; ele não pode executar contêineres do Windows2022 e vice-versa.
Windows2022	Use o Windows2022 como o sistema operacional para imagens de nó. Não suportado para pools de nós do sistema. O Windows2022 suporta apenas contêineres do Windows2022; ele não pode executar contêineres do Windows2019 e vice-versa.
Ubuntu2204	Use o Ubuntu2204 como o sistema operacional para imagens de nós, no entanto, o Ubuntu 22.04 pode não ser suportado para todos os nodepools. Para limitações e versões kubernetes suportadas, consulte https://aka.ms/aks/supported-ubuntu-versions
Windows2025	Use o Windows2025 como o sistema operacional para imagens de nó. Não suportado para pools de nós do sistema. O Windows2025 suporta contentores Windows2022 e Windows 2025; não pode correr containers Windows2019 e vice-versa.
Ubuntu2404	Use o Ubuntu2404 como o sistema operacional para imagens de nós, no entanto, o Ubuntu 24.04 pode não ser suportado para todos os nodepools. Para limitações e versões suportadas do kubernetes, consulte https://aka.ms/aks/supported-ubuntu-versions
AzureContainerLinux	Use o Azure Container Linux como sistema operativo para imagens de nós. Azure Container Linux é um sistema operativo Linux otimizado para contentores e focado na segurança, construído sobre Azure Linux, com um sistema de ficheiros imutável. O ACL deriva do projeto Flatcar Container Linux, baseando-se no comprovado design imutável e baseado em contentores do Flatcar, ao mesmo tempo que adiciona pacotes Linux Azure, serviços e integração profunda com o ciclo de vida do Azure e do AKS. Para mais informações, consulte https://aka.ms/azurecontainerlinux

OSType

Enumeração

O tipo de sistema operacional. O padrão é Linux.

Valor	Description
Linux	Usa Linux.
Windows	Usa o Windows.

Snapshot

Object

Um recurso de instantâneo do pool de nós.

Name	Tipo	Default value	Description
id	string (arm-id)		ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		A geolocalização onde o recurso vive
name	string		O nome do recurso
properties.creationData	CreationData		CreationData a ser usado para especificar o ID de recurso do pool de agentes de origem para criar esse instantâneo.
properties.enableFIPS	boolean		Se deve usar um sistema operacional habilitado para FIPS.
properties.kubernetesVersion	string		A versão do Kubernetes.
properties.nodeImageVersion	string		A versão da imagem do nó.
properties.osSku	OSSKU		Especifica a SKU do sistema operacional usada pelo pool de agentes. O padrão é Ubuntu se OSType é Linux. O padrão é Windows2019 quando o Kubernetes <= 1.24 ou Windows2022 quando o Kubernetes >= 1.25 se OSType for Windows.
properties.osType	OSType	Linux	O tipo de sistema operacional. O padrão é Linux.
properties.snapshotType	SnapshotType	NodePool	O tipo de instantâneo. O padrão é NodePool.
properties.vmSize	string		O tamanho da VM.
systemData	systemData		Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object		Tags de recursos.
type	string		O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

SnapshotType

Enumeração

O tipo de instantâneo. O padrão é NodePool.

Valor	Description
NodePool	O instantâneo é um instantâneo de um pool de nós.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TagsObject

Object

Tags objeto para operações de patch.

Name	Tipo	Description
tags	object	Tags de recursos.