PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/?api-version=2023-10-02

The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

The name of the resource group.

Default value: "application/json"

Resource Id

The complex type of the extended location.

The name of the extended location.

The type of extendedLocation.

Possible values:

• "EdgeZone"

The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot

The sku tier.

The sku name.

Possible values:

• "Standard_ZRS"
• "Standard_LRS"
• "Premium_LRS"

Resource name

Snapshot resource properties.

Encryption settings for disk or snapshot

A collection of encryption settings, one for each disk volume.

Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey

The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Resource Id

Url pointing to a key or secret in KeyVault

Key Vault Secret Url and vault id of the encryption key

The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Resource Id

Url pointing to a key or secret in KeyVault

Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.

Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.

Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.

Additional authentication requirements when exporting or uploading to a disk or snapshot.

Possible values:

• "None"
• "AzureActiveDirectory"

Contains the security related information for the resource.

Specifies the SecurityType of the VM. Applicable for OS disks only.

Possible values:

• "ConfidentialVM_NonPersistedTPM"
• "TrustedLaunch"
• "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey"
• "ConfidentialVM_DiskEncryptedWithPlatformKey"
• "ConfidentialVM_DiskEncryptedWithCustomerKey"

ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key

ARM id of the DiskAccess resource for using private endpoints on disks.

If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.

This enumerates the possible state of the disk.

Possible values:

• "ActiveSAS"
• "Frozen"
• "Unattached"
• "Attached"
• "ActiveSASFrozen"
• "ReadyToUpload"
• "ActiveUpload"
• "Reserved"

Indicates the OS on a snapshot supports hibernation.

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

The plan ID.

The publisher ID.

Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

The Offer Promotion Code.

Percentage complete for the background copy when a resource is created via the CopyStart operation.

Encryption at rest settings for disk or snapshot

ResourceId of the disk encryption set to use for enabling encryption at rest.

The type of key used to encrypt the data of the disk.

Possible values:

• "EncryptionAtRestWithCustomerKey"
• "EncryptionAtRestWithPlatformKey"
• "EncryptionAtRestWithPlatformAndCustomerKeys"

The time when the snapshot was created.

Indicates the error details if the background copy of a resource created via the CopyStart operation fails.

Indicates the error message if the background copy of a resource created via the CopyStart operation fails.

Indicates the error code if the background copy of a resource created via the CopyStart operation fails.

Possible values:

• "CopySourceNotFound"

The size of the disk in bytes. This field is read only.

Unique Guid identifying the resource.

The Operating System type.

Possible values:

• "Windows"
• "Linux"

Policy for controlling export on the disk.

Possible values:

• "Disabled"
• "Enabled"

The disk provisioning state.

Policy for accessing the disk via network.

Possible values:

• "DenyAll"
• "AllowPrivate"
• "AllowAll"

List of supported capabilities persisted on the disk resource for VM use.

True if the image from which the OS disk is created supports accelerated networking.

The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.

CPU architecture supported by an OS disk.

Possible values:

• "x64"
• "Arm64"

The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

Possible values:

• "V2"
• "V1"

Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.

Data used when creating a disk.

If createOption is Import, this is the URI of a blob to be imported into a managed disk.

If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.

Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.

The source image used for creating the disk.

A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.

A relative uri containing a direct shared Azure Compute Gallery image reference.

If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.

A relative uri containing a community Azure Compute Gallery image reference.

Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.

If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.

Possible values:

• "Enhanced"
• "None"

If this field is set, this is the unique id identifying the source of this resource.

Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.

If createOption is Copy, this is the ARM id of the source snapshot or disk.

If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).

This enumerates the possible sources of a disk's creation.

Possible values:

• "Empty"
• "Upload"
• "ImportSecure"
• "Copy"
• "Attach"
• "FromImage"
• "Import"
• "Restore"
• "UploadPreparedSecure"
• "CopyFromSanSnapshot"
• "CopyStart"

The source image used for creating the disk.

A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.

A relative uri containing a direct shared Azure Compute Gallery image reference.

If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.

A relative uri containing a community Azure Compute Gallery image reference.

Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.

Resource location

Unused. Always Null.

Resource tags

Resource type