PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/?api-version=2023-10-02
Updates (patches) a snapshot.
Servers
- https://management.azure.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
snapshotName |
String | Yes |
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. |
subscriptionId |
String | Yes |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
resourceGroupName |
String | Yes |
The name of the resource group. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
sku |
Object | No |
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 |
sku.tier |
String | No |
The sku tier. |
sku.name |
String | No |
The sku name. Possible values:
|
properties |
Object | No |
Snapshot resource update properties. |
properties.encryptionSettingsCollection |
Object | No |
Encryption settings for disk or snapshot |
properties.encryptionSettingsCollection.encryptionSettings[] |
Array | No |
A collection of encryption settings, one for each disk volume. |
properties.encryptionSettingsCollection.encryptionSettings[].keyEncryptionKey |
Object | No |
Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey |
properties.encryptionSettingsCollection.encryptionSettings[].keyEncryptionKey.sourceVault |
Object | Yes |
The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} |
properties.encryptionSettingsCollection.encryptionSettings[].keyEncryptionKey.sourceVault.id |
String | No |
Resource Id |
properties.encryptionSettingsCollection.encryptionSettings[].keyEncryptionKey.keyUrl |
String | Yes |
Url pointing to a key or secret in KeyVault |
properties.encryptionSettingsCollection.encryptionSettings[].diskEncryptionKey |
Object | No |
Key Vault Secret Url and vault id of the encryption key |
properties.encryptionSettingsCollection.encryptionSettings[].diskEncryptionKey.sourceVault |
Object | Yes |
The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} |
properties.encryptionSettingsCollection.encryptionSettings[].diskEncryptionKey.sourceVault.id |
String | No |
Resource Id |
properties.encryptionSettingsCollection.encryptionSettings[].diskEncryptionKey.secretUrl |
String | Yes |
Url pointing to a key or secret in KeyVault |
properties.encryptionSettingsCollection.enabled |
Boolean | Yes |
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. |
properties.encryptionSettingsCollection.encryptionSettingsVersion |
String | No |
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. |
properties.dataAccessAuthMode |
String | No |
Additional authentication requirements when exporting or uploading to a disk or snapshot. Possible values:
|
properties.osType |
String | No |
the Operating System type. Possible values:
|
properties.diskAccessId |
String | No |
ARM id of the DiskAccess resource for using private endpoints on disks. |
properties.publicNetworkAccess |
String | No |
Policy for controlling export on the disk. Possible values:
|
properties.networkAccessPolicy |
String | No |
Policy for accessing the disk via network. Possible values:
|
properties.diskSizeGB |
Integer | No |
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. |
properties.supportsHibernation |
Boolean | No |
Indicates the OS on a snapshot supports hibernation. |
properties.supportedCapabilities |
Object | No |
List of supported capabilities persisted on the disk resource for VM use. |
properties.supportedCapabilities.acceleratedNetwork |
Boolean | No |
True if the image from which the OS disk is created supports accelerated networking. |
properties.supportedCapabilities.diskControllerTypes |
String | No |
The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. |
properties.supportedCapabilities.architecture |
String | No |
CPU architecture supported by an OS disk. Possible values:
|
properties.encryption |
Object | No |
Encryption at rest settings for disk or snapshot |
properties.encryption.diskEncryptionSetId |
String | No |
ResourceId of the disk encryption set to use for enabling encryption at rest. |
properties.encryption.type |
String | No |
The type of key used to encrypt the data of the disk. Possible values:
|
tags |
Object | No |
Resource tags |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.