Microsoft.ContainerService snapshots

Bicep resource definition

The snapshots resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerService/snapshots resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ContainerService/snapshots@2026-03-02-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    creationData: {
      sourceResourceId: 'string'
    }
    snapshotType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.ContainerService/snapshots

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 63
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required)
properties Properties of a snapshot. SnapshotProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

CreationData

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

SnapshotProperties

Name Description Value
creationData CreationData to be used to specify the source agent pool resource ID to create this snapshot. CreationData
snapshotType The type of a snapshot. The default is NodePool. 'ManagedCluster'
'NodePool'

TrackedResourceTags

Name Description Value

ARM template resource definition

The snapshots resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerService/snapshots resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerService/snapshots",
  "apiVersion": "2026-03-02-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "creationData": {
      "sourceResourceId": "string"
    },
    "snapshotType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.ContainerService/snapshots

Name Description Value
apiVersion The api version '2026-03-02-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 63
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required)
properties Properties of a snapshot. SnapshotProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.ContainerService/snapshots'

CreationData

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

SnapshotProperties

Name Description Value
creationData CreationData to be used to specify the source agent pool resource ID to create this snapshot. CreationData
snapshotType The type of a snapshot. The default is NodePool. 'ManagedCluster'
'NodePool'

TrackedResourceTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The snapshots resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerService/snapshots resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerService/snapshots@2026-03-02-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      creationData = {
        sourceResourceId = "string"
      }
      snapshotType = "string"
    }
  }
}

Property Values

Microsoft.ContainerService/snapshots

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 63
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required)
properties Properties of a snapshot. SnapshotProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.ContainerService/snapshots@2026-03-02-preview"

CreationData

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

SnapshotProperties

Name Description Value
creationData CreationData to be used to specify the source agent pool resource ID to create this snapshot. CreationData
snapshotType The type of a snapshot. The default is NodePool. 'ManagedCluster'
'NodePool'

TrackedResourceTags

Name Description Value
  • Last updated on