Snapshots - List

Reference

Service:: AKS

API Version:: 2024-05-01

Gets a list of snapshots in the specified subscription.

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

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	SnapshotListResult	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List Snapshots

Sample request

HTTP

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

Sample response

Status code:: 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
      }
    }
  ]
}

Definitions

Name	Description
CloudError	An error response from the Container service.
CloudErrorBody	An error response from the Container service.
createdByType	The type of identity that created the resource.
CreationData	Data used when creating a target resource from a source resource.
OSSKU	Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
OSType	The operating system type. The default is Linux.
Snapshot	A node pool snapshot resource.
SnapshotListResult	The response from the List Snapshots operation.
SnapshotType	The type of a snapshot. The default is NodePool.
systemData	Metadata pertaining to creation and last modification of the resource.

CloudError

An error response from the Container service.

Name	Type	Description
error	CloudErrorBody	Details about the error.

CloudErrorBody

An error response from the Container service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreationData

Data used when creating a target resource from a source resource.

Name	Type	Description
sourceResourceId	string	This is the ARM ID of the source object to be used to create the target object.

OSSKU

Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.

Name	Type	Description
AzureLinux	string	Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information.
CBLMariner	string	Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead.
Ubuntu	string	Use Ubuntu as the OS for node images.
Windows2019	string	Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa.
Windows2022	string	Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa.

OSType

The operating system type. The default is Linux.

Name	Type	Description
Linux	string	Use Linux.
Windows	string	Use Windows.

Snapshot

A node pool snapshot resource.

Name	Type	Default value	Description
id	string		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.creationData	CreationData		CreationData to be used to specify the source agent pool resource ID to create this snapshot.
properties.enableFIPS	boolean		Whether to use a FIPS-enabled OS.
properties.kubernetesVersion	string		The version of Kubernetes.
properties.nodeImageVersion	string		The version of node image.
properties.osSku	OSSKU		Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
properties.osType	OSType	Linux	The operating system type. The default is Linux.
properties.snapshotType	SnapshotType	NodePool	The type of a snapshot. The default is NodePool.
properties.vmSize	string		The size of the VM.
systemData	systemData		Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SnapshotListResult

The response from the List Snapshots operation.

Name	Type	Description
nextLink	string	The URL to get the next set of snapshot results.
value	Snapshot[]	The list of snapshots.

SnapshotType

The type of a snapshot. The default is NodePool.

Name	Type	Description
NodePool	string	The snapshot is a snapshot of a node pool.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via