Snapshots - Create Or Update

Servizio:: AKS

Versione API:: 2025-04-01

Crea o aggiorna uno snapshot.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
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]$	Nome della risorsa cluster gestita.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione geografica in cui risiede la risorsa
properties.creationData		CreationData	CreationData da usare per specificare l'ID risorsa del pool di agenti di origine per creare questo snapshot.
properties.snapshotType		SnapshotType	Tipo di snapshot. Il valore predefinito è NodePool.
tags		object	Tag di risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	Snapshot	Lo snapshot esistente è stato aggiornato correttamente.
201 Created	Snapshot	Il nuovo snapshot è stato creato correttamente.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create/Update Snapshot

Esempio di richiesta

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

{
  "location": "westus",
  "tags": {
    "key1": "val1",
    "key2": "val2"
  },
  "properties": {
    "creationData": {
      "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"
    }
  }
}


import com.azure.resourcemanager.containerservice.fluent.models.SnapshotInner;
import com.azure.resourcemanager.containerservice.models.CreationData;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Snapshots CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-04-01/examples/
     * SnapshotsCreate.json
     */
    /**
     * Sample code: Create/Update Snapshot.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createUpdateSnapshot(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getSnapshots()
            .createOrUpdateWithResponse("rg1", "snapshot1", new SnapshotInner().withLocation("westus")
                .withTags(mapOf("key1", "fakeTokenPlaceholder", "key2", "fakeTokenPlaceholder"))
                .withCreationData(new CreationData().withSourceResourceId(
                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0")),
                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_create.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.snapshots.create_or_update(
        resource_group_name="rg1",
        resource_name="snapshot1",
        parameters={
            "location": "westus",
            "properties": {
                "creationData": {
                    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"
                }
            },
            "tags": {"key1": "val1", "key2": "val2"},
        },
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-04-01/examples/SnapshotsCreate.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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/87bd051c295d94fffa28a4fa6b18f8b4b71c50ec/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-04-01/examples/SnapshotsCreate.json
func ExampleSnapshotsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSnapshotsClient().CreateOrUpdate(ctx, "rg1", "snapshot1", armcontainerservice.Snapshot{
		Location: to.Ptr("westus"),
		Tags: map[string]*string{
			"key1": to.Ptr("val1"),
			"key2": to.Ptr("val2"),
		},
		Properties: &armcontainerservice.SnapshotProperties{
			CreationData: &armcontainerservice.CreationData{
				SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"),
			},
		},
	}, 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.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"),
	// 	SystemData: &armcontainerservice.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-09T20:13:23.298Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armcontainerservice.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("val1"),
	// 		"key2": to.Ptr("val2"),
	// 	},
	// 	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"),
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates a snapshot.
 *
 * @summary Creates or updates a snapshot.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-04-01/examples/SnapshotsCreate.json
 */
async function createOrUpdateSnapshot() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "snapshot1";
  const parameters = {
    creationData: {
      sourceResourceId:
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0",
    },
    location: "westus",
    tags: { key1: "val1", key2: "val2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.snapshots.createOrUpdate(resourceGroupName, resourceName, parameters);
  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

Risposta di esempio

Codice di stato:: 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
  }
}

Codice di stato:: 201

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

Definizioni

Nome	Descrizione
CloudError	Risposta di errore dal servizio Contenitore.
CloudErrorBody	Risposta di errore dal servizio Contenitore.
createdByType	Tipo di identità che ha creato la risorsa.
CreationData	Dati usati durante la creazione di una risorsa di destinazione da una risorsa di origine.
OSSKU	Specifica lo SKU del sistema operativo usato dal pool di agenti. Il valore predefinito è Ubuntu se OSType è Linux. Il valore predefinito è Windows2019 quando Kubernetes <= 1.24 o Windows2022 quando Kubernetes >= 1.25 se OSType è Windows.
OSType	Tipo di sistema operativo. Il valore predefinito è Linux.
Snapshot	Risorsa snapshot del pool di nodi.
SnapshotType	Tipo di snapshot. Il valore predefinito è NodePool.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

CloudError

Object

Risposta di errore dal servizio Contenitore.

Nome	Tipo	Descrizione
error	CloudErrorBody	Dettagli sull'errore.

CloudErrorBody

Object

Risposta di errore dal servizio Contenitore.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

CreationData

Object

Dati usati durante la creazione di una risorsa di destinazione da una risorsa di origine.

Nome	Tipo	Descrizione
sourceResourceId	string (arm-id)	Si tratta dell'ID ARM dell'oggetto di origine da usare per creare l'oggetto di destinazione.

OSSKU

Enumerazione

Specifica lo SKU del sistema operativo usato dal pool di agenti. Il valore predefinito è Ubuntu se OSType è Linux. Il valore predefinito è Windows2019 quando Kubernetes <= 1.24 o Windows2022 quando Kubernetes >= 1.25 se OSType è Windows.

Valore	Descrizione
AzureLinux	Usare AzureLinux come sistema operativo per le immagini dei nodi. Linux di Azure è una distribuzione Linux ottimizzata per i contenitori creata da Microsoft. Per altre informazioni, visitare https://aka.ms/azurelinux.
CBLMariner	OSSKU deprecato. Microsoft consiglia di scegliere invece "AzureLinux" per le nuove distribuzioni.
Ubuntu	Usare Ubuntu come sistema operativo per le immagini del nodo.
Ubuntu2204	Utilizzare Ubuntu2204 come sistema operativo per le immagini dei nodi, tuttavia, Ubuntu 22.04 potrebbe non essere supportato per tutti i pool di nodi. Per le limitazioni e le versioni di kubernetes supportate, vedere https://aka.ms/aks/supported-ubuntu-versions
Windows2019	Usare Windows2019 come sistema operativo per le immagini del nodo. Non supportato per i pool di nodi di sistema. Windows2019 supporta solo i contenitori Windows2019; non può eseguire contenitori Windows2022 e viceversa.
Windows2022	Usare Windows2022 come sistema operativo per le immagini del nodo. Non supportato per i pool di nodi di sistema. Windows2022 supporta solo contenitori Windows2022; non può eseguire contenitori Windows2019 e viceversa.

OSType

Enumerazione

Tipo di sistema operativo. Il valore predefinito è Linux.

Valore	Descrizione
Linux	Usare Linux.
Windows	Usare Windows.

Snapshot

Object

Risorsa snapshot del pool di nodi.

Nome	Tipo	Valore predefinito	Descrizione
id	string (arm-id)		ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		Posizione geografica in cui risiede la risorsa
name	string		Nome della risorsa
properties.creationData	CreationData		CreationData da usare per specificare l'ID risorsa del pool di agenti di origine per creare questo snapshot.
properties.enableFIPS	boolean		Indica se usare un sistema operativo abilitato per FIPS.
properties.kubernetesVersion	string		Versione di Kubernetes.
properties.nodeImageVersion	string		Versione dell'immagine del nodo.
properties.osSku	OSSKU		Specifica lo SKU del sistema operativo usato dal pool di agenti. Il valore predefinito è Ubuntu se OSType è Linux. Il valore predefinito è Windows2019 quando Kubernetes <= 1.24 o Windows2022 quando Kubernetes >= 1.25 se OSType è Windows.
properties.osType	OSType	Linux	Tipo di sistema operativo. Il valore predefinito è Linux.
properties.snapshotType	SnapshotType	NodePool	Tipo di snapshot. Il valore predefinito è NodePool.
properties.vmSize	string		Dimensioni della macchina virtuale.
systemData	systemData		Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object		Tag di risorsa.
type	string		Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SnapshotType

Enumerazione

Tipo di snapshot. Il valore predefinito è NodePool.

Valore	Descrizione
NodePool	Lo snapshot è uno snapshot di un pool di nodi.

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Condividi tramite

Snapshots - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Create/Update Snapshot

Esempio di richiesta

Risposta di esempio

Definizioni

CloudError

CloudErrorBody

createdByType

CreationData

OSSKU

OSType

Snapshot

SnapshotType

systemData