Share via

Microsoft.ContainerService snapshots 2023-05-01

  • Article

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@2023-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    creationData: {
      sourceResourceId: 'string'
    }
    snapshotType: 'NodePool'
  }
}

Property values

snapshots

Name Description Value
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Properties of a snapshot. SnapshotProperties

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. 'NodePool'

CreationData

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

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": "2023-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "creationData": {
      "sourceResourceId": "string"
    },
    "snapshotType": "NodePool"
  }
}

Property values

snapshots

Name Description Value
type The resource type 'Microsoft.ContainerService/snapshots'
apiVersion The resource api version '2023-05-01'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Properties of a snapshot. SnapshotProperties

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. 'NodePool'

CreationData

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

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@2023-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      creationData = {
        sourceResourceId = "string"
      }
      snapshotType = "NodePool"
    }
  })
}

Property values

snapshots

Name Description Value
type The resource type "Microsoft.ContainerService/snapshots@2023-05-01"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
properties Properties of a snapshot. SnapshotProperties

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. "NodePool"

CreationData

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