Snapshots - List By Resource Group

Service:: AKS

Version d'API:: 2025-05-01

Répertorie les instantanés dans l’abonnement et le groupe de ressources spécifiés.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	SnapshotListResult	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

List Snapshots by Resource Group

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "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
      }
    }
  ]
}

Définitions

Nom	Description
CloudError	Réponse d’erreur du service Conteneur.
CloudErrorBody	Réponse d’erreur du service Conteneur.
createdByType	Type d’identité qui a créé la ressource.
CreationData	Données utilisées lors de la création d’une ressource cible à partir d’une ressource source.
OSSKU	Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est Ubuntu si OSType est Linux. La valeur par défaut est Windows2019 quand Kubernetes <= 1.24 ou Windows2022 quand Kubernetes >= 1.25 si OSType est Windows.
OSType	Type de système d’exploitation. La valeur par défaut est Linux.
Snapshot	Ressource d’instantané de pool de nœuds.
SnapshotListResult	Réponse de l’opération d’instantanés de liste.
SnapshotType	Type d’instantané. La valeur par défaut est NodePool.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CloudError

Object

Réponse d’erreur du service Conteneur.

Nom	Type	Description
error	CloudErrorBody	Détails sur l’erreur.

CloudErrorBody

Object

Réponse d’erreur du service Conteneur.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

CreationData

Object

Données utilisées lors de la création d’une ressource cible à partir d’une ressource source.

Nom	Type	Description
sourceResourceId	string (arm-id)	Il s’agit de l’ID ARM de l’objet source à utiliser pour créer l’objet cible.

OSSKU

Énumération

Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est Ubuntu si OSType est Linux. La valeur par défaut est Windows2019 quand Kubernetes <= 1.24 ou Windows2022 quand Kubernetes >= 1.25 si OSType est Windows.

Valeur	Description
AzureLinux	Utilisez AzureLinux comme système d’exploitation pour les images de nœud. Azure Linux est une distribution Linux optimisée par conteneur créée par Microsoft, visitez https://aka.ms/azurelinux pour plus d’informations.
CBLMariner	Référence OSSKU déconseillée. Microsoft recommande que les nouveaux déploiements choisissent « AzureLinux » à la place.
Ubuntu	Utilisez Ubuntu comme système d’exploitation pour les images de nœud.
Ubuntu2204	Utilisez Ubuntu2204 comme système d’exploitation pour les images de nœuds, cependant, Ubuntu 22.04 peut ne pas être pris en charge pour tous les pools de nœuds. Pour connaître les limitations et les versions de Kubernetes prises en charge, consultez https://aka.ms/aks/supported-ubuntu-versions
Windows2019	Utilisez Windows2019 comme système d’exploitation pour les images de nœud. Non pris en charge pour les pools de nœuds système. Windows2019 prend uniquement en charge les conteneurs Windows2019 ; il ne peut pas exécuter les conteneurs Windows2022 et vice versa.
Windows2022	Utilisez Windows2022 comme système d’exploitation pour les images de nœud. Non pris en charge pour les pools de nœuds système. Windows2022 prend uniquement en charge les conteneurs Windows2022 ; il ne peut pas exécuter les conteneurs Windows2019 et vice versa.

OSType

Énumération

Type de système d’exploitation. La valeur par défaut est Linux.

Valeur	Description
Linux	Utilisez Linux.
Windows	Utilisez Windows.

Snapshot

Object

Ressource d’instantané de pool de nœuds.

Nom	Type	Valeur par défaut	Description
id	string (arm-id)		ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
location	string		Emplacement géographique où réside la ressource
name	string		Nom de la ressource
properties.creationData	CreationData		CreationData à utiliser pour spécifier l’ID de ressource du pool d’agents sources pour créer cet instantané.
properties.enableFIPS	boolean		Indique s’il faut utiliser un système d’exploitation compatible FIPS.
properties.kubernetesVersion	string		Version de Kubernetes.
properties.nodeImageVersion	string		Version de l’image de nœud.
properties.osSku	OSSKU		Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est Ubuntu si OSType est Linux. La valeur par défaut est Windows2019 quand Kubernetes <= 1.24 ou Windows2022 quand Kubernetes >= 1.25 si OSType est Windows.
properties.osType	OSType	Linux	Type de système d’exploitation. La valeur par défaut est Linux.
properties.snapshotType	SnapshotType	NodePool	Type d’instantané. La valeur par défaut est NodePool.
properties.vmSize	string		Taille de la machine virtuelle.
systemData	systemData		Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object		Balises de ressource.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SnapshotListResult

Object

Réponse de l’opération d’instantanés de liste.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir le jeu de résultats d’instantané suivant.
value	Snapshot[]	Liste des instantanés.

SnapshotType

Énumération

Type d’instantané. La valeur par défaut est NodePool.

Valeur	Description
NodePool	L’instantané est un instantané d’un pool de nœuds.

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Snapshots - List By Resource Group

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

List Snapshots by Resource Group

Exemple de requête

Exemple de réponse

Définitions

CloudError

CloudErrorBody

createdByType

CreationData

OSSKU

OSType

Snapshot

SnapshotListResult

SnapshotType

systemData