snapshots

Creates, updates, deletes, gets or lists a snapshots resource.

Overview

Name	snapshots
Type	Resource
Id	azure.container_service.snapshots

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationData	object	CreationData to be used to specify the source agent pool resource ID to create this snapshot.
enableFIPS	boolean	Whether to use a FIPS-enabled OS.
kubernetesVersion	string	The version of Kubernetes.
location	string	The geo-location where the resource lives. Required.
nodeImageVersion	string	The version of node image.
osSku	string	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. Known values are: "Ubuntu", "AzureLinux", "AzureLinux3", "Mariner", "Flatcar", "CBLMariner", "Windows2019", "Windows2022", "Ubuntu2204", "Windows2025", "WindowsAnnual", "Ubuntu2404", and "AzureContainerLinux". (Ubuntu, AzureLinux, AzureLinux3, Mariner, Flatcar, CBLMariner, Windows2019, Windows2022, Ubuntu2204, Windows2025, WindowsAnnual, Ubuntu2404, AzureContainerLinux)
osType	string	The operating system type. The default is Linux. Known values are: "Linux" and "Windows". (Linux, Windows)
snapshotType	string	The type of a snapshot. The default is NodePool. Known values are: "NodePool" and "ManagedCluster". (NodePool, ManagedCluster)
systemData	object	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".
vmSize	string	The size of the VM.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationData	object	CreationData to be used to specify the source agent pool resource ID to create this snapshot.
enableFIPS	boolean	Whether to use a FIPS-enabled OS.
kubernetesVersion	string	The version of Kubernetes.
location	string	The geo-location where the resource lives. Required.
nodeImageVersion	string	The version of node image.
osSku	string	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. Known values are: "Ubuntu", "AzureLinux", "AzureLinux3", "Mariner", "Flatcar", "CBLMariner", "Windows2019", "Windows2022", "Ubuntu2204", "Windows2025", "WindowsAnnual", "Ubuntu2404", and "AzureContainerLinux". (Ubuntu, AzureLinux, AzureLinux3, Mariner, Flatcar, CBLMariner, Windows2019, Windows2022, Ubuntu2204, Windows2025, WindowsAnnual, Ubuntu2404, AzureContainerLinux)
osType	string	The operating system type. The default is Linux. Known values are: "Linux" and "Windows". (Linux, Windows)
snapshotType	string	The type of a snapshot. The default is NodePool. Known values are: "NodePool" and "ManagedCluster". (NodePool, ManagedCluster)
systemData	object	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".
vmSize	string	The size of the VM.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationData	object	CreationData to be used to specify the source agent pool resource ID to create this snapshot.
enableFIPS	boolean	Whether to use a FIPS-enabled OS.
kubernetesVersion	string	The version of Kubernetes.
location	string	The geo-location where the resource lives. Required.
nodeImageVersion	string	The version of node image.
osSku	string	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. Known values are: "Ubuntu", "AzureLinux", "AzureLinux3", "Mariner", "Flatcar", "CBLMariner", "Windows2019", "Windows2022", "Ubuntu2204", "Windows2025", "WindowsAnnual", "Ubuntu2404", and "AzureContainerLinux". (Ubuntu, AzureLinux, AzureLinux3, Mariner, Flatcar, CBLMariner, Windows2019, Windows2022, Ubuntu2204, Windows2025, WindowsAnnual, Ubuntu2404, AzureContainerLinux)
osType	string	The operating system type. The default is Linux. Known values are: "Linux" and "Windows". (Linux, Windows)
snapshotType	string	The type of a snapshot. The default is NodePool. Known values are: "NodePool" and "ManagedCluster". (NodePool, ManagedCluster)
systemData	object	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".
vmSize	string	The size of the VM.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, subscription_id		Gets a snapshot.
list_by_resource_group	select	resource_group_name, subscription_id		Lists snapshots in the specified subscription and resource group.
list	select	subscription_id		Gets a list of snapshots in the specified subscription.
create_or_update	insert	resource_group_name, resource_name, subscription_id, location		Creates or updates a snapshot.
update_tags	update	resource_group_name, resource_name, subscription_id		Updates tags on a snapshot.
create_or_update	replace	resource_group_name, resource_name, subscription_id, location		Creates or updates a snapshot.
delete	delete	resource_group_name, resource_name, subscription_id		Deletes a snapshot.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the managed cluster resource. Required.
subscription_id	string

SELECT examples

get

Gets a snapshot.

SELECT
id,
name,
creationData,
enableFIPS,
kubernetesVersion,
location,
nodeImageVersion,
osSku,
osType,
snapshotType,
systemData,
tags,
type,
vmSize
FROM azure.container_service.snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists snapshots in the specified subscription and resource group.

SELECT
id,
name,
creationData,
enableFIPS,
kubernetesVersion,
location,
nodeImageVersion,
osSku,
osType,
snapshotType,
systemData,
tags,
type,
vmSize
FROM azure.container_service.snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of snapshots in the specified subscription.

SELECT
id,
name,
creationData,
enableFIPS,
kubernetesVersion,
location,
nodeImageVersion,
osSku,
osType,
snapshotType,
systemData,
tags,
type,
vmSize
FROM azure.container_service.snapshots
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a snapshot.

INSERT INTO azure.container_service.snapshots (
tags,
location,
properties,
resource_group_name,
resource_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: snapshots
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the snapshots resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the snapshots resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the snapshots resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of a snapshot.
    value:
      creationData:
        sourceResourceId: "{{ sourceResourceId }}"
      snapshotType: "{{ snapshotType }}"
      kubernetesVersion: "{{ kubernetesVersion }}"
      nodeImageVersion: "{{ nodeImageVersion }}"
      osType: "{{ osType }}"
      osSku: "{{ osSku }}"
      vmSize: "{{ vmSize }}"
      enableFIPS: {{ enableFIPS }}

UPDATE examples

update_tags

Updates tags on a snapshot.

UPDATE azure.container_service.snapshots
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a snapshot.

REPLACE azure.container_service.snapshots
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a snapshot.

DELETE FROM azure.container_service.snapshots
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;