Microsoft.Compute (stable:2025-01-02)

2025/06/25 • 38 new, 38 deleted methods

DiskAccesses_List (new)
Description :  Lists all the disk access resources under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disk access resources. ,
Required: True ,
}
[
{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disk access resources. Call ListNext() with this to fetch the next page of disk access resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_List (new)
Description :  Lists all the disk encryption sets under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disk encryption sets. ,
Required: True ,
}
[
{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disk encryption sets. Call ListNext() with this to fetch the next page of disk encryption sets. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Disks_List (new)
Description :  Lists all the disks under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disks. ,
Required: True ,
}
[
{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks. ,
Required: False ,
}
string ,
}
Snapshots_List (new)
Description :  Lists snapshots under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/snapshots
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of snapshots. ,
Required: True ,
}
[
{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots. ,
Required: False ,
}
string ,
}
DiskAccesses_ListByResourceGroup (new)
Description :  Lists all the disk access resources under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disk access resources. ,
Required: True ,
}
[
{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disk access resources. Call ListNext() with this to fetch the next page of disk access resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_Get (new)
Description :  Gets information about a disk access resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_CreateOrUpdate (new)
Description :  Creates or updates a disk access resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
diskAccess:
{
Description: disk access object supplied in the body of the Put disk access operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_Update (new)
Description :  Updates (patches) a disk access resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
diskAccess:
{
Description: disk access object supplied in the body of the Patch disk access operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_Delete (new)
Description :  Deletes a disk access resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_ListPrivateEndpointConnections (new)
Description :  List information about private endpoint connections under a disk access resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_GetAPrivateEndpointConnection (new)
Description :  Gets information about a private endpoint connection under a disk access resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_UpdateAPrivateEndpointConnection (new)
Description :  Approve or reject a private endpoint connection under disk access resource, this can't be used to create a new private endpoint connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: private endpoint connection object supplied in the body of the Put private endpoint connection operation. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_DeleteAPrivateEndpointConnection (new)
Description :  Deletes a private endpoint connection under a disk access resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_GetPrivateLinkResources (new)
Description :  Gets the private link resources possible under disk access resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privatelinkresources
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: private link resource Id ,
Required: False ,
}
string ,
name:
{
Description: private link resource name ,
Required: False ,
}
string ,
type:
{
Description: private link resource type ,
Required: False ,
}
string ,
}
,
]
,
}
DiskEncryptionSets_ListByResourceGroup (new)
Description :  Lists all the disk encryption sets under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disk encryption sets. ,
Required: True ,
}
[
{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disk encryption sets. Call ListNext() with this to fetch the next page of disk encryption sets. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_Get (new)
Description :  Gets information about a disk encryption set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskEncryptionSetName:
{
Description: The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_CreateOrUpdate (new)
Description :  Creates or updates a disk encryption set
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskEncryptionSetName:
{
Description: The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
diskEncryptionSet:
{
Description: disk encryption set object supplied in the body of the Put disk encryption set operation. ,
Required: True ,
}
{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_Update (new)
Description :  Updates (patches) a disk encryption set.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskEncryptionSetName:
{
Description: The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
diskEncryptionSet:
{
Description: disk encryption set object supplied in the body of the Patch disk encryption set operation. ,
Required: True ,
}
{
properties:
{
Description: disk encryption set resource update properties. ,
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_Delete (new)
Description :  Deletes a disk encryption set.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskEncryptionSetName:
{
Description: The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_ListAssociatedResources (new)
Description :  Lists all resources that are encrypted with this disk encryption set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}/associatedResources
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskEncryptionSetName:
{
Description: The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of IDs or Owner IDs of resources which are encrypted with the disk encryption set. ,
Required: True ,
}
[
string ,
]
,
nextLink:
{
Description: The uri to fetch the next page of encrypted resources. Call ListNext() with this to fetch the next page of encrypted resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Disks_ListByResourceGroup (new)
Description :  Lists all the disks under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disks. ,
Required: True ,
}
[
{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks. ,
Required: False ,
}
string ,
}
Disks_Get (new)
Description :  Gets information about a disk.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
Disks_CreateOrUpdate (new)
Description :  Creates or updates a disk.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
disk:
{
Description: Disk object supplied in the body of the Put disk operation. ,
Required: True ,
}
{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
Disks_Update (new)
Description :  Updates (patches) a disk.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
disk:
{
Description: Disk object supplied in the body of the Patch disk operation. ,
Required: True ,
}
{
properties:
{
Description: Disk resource update properties. ,
Required: False ,
}
{
osType:
{
Description: the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
purchasePlan:
{
Description: Purchase plan information to be added on the OS disk ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities to be added on the OS disk. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
Disks_Delete (new)
Description :  Deletes a disk.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Disks_GrantAccess (new)
Description :  Grants access to a disk.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/beginGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
grantAccessData:
{
Description: Access data object supplied in the body of the get disk access operation. ,
Required: True ,
}
{
access:
{
Enum:
{
None: No description available. ,
Read: No description available. ,
Write: No description available. ,
}
,
Required: True ,
}
enum ,
durationInSeconds:
{
Description: Time duration in seconds until the SAS access expires. ,
Format: int32 ,
Required: True ,
}
integer ,
getSecureVMGuestStateSAS:
{
Description: Set this flag to true to get additional SAS for VM guest state ,
Required: False ,
}
boolean ,
fileFormat:
{
Description: Used to specify the file format when making request for SAS on a VHDX file format snapshot ,
Enum:
{
VHD: A VHD file is a disk image file in the Virtual Hard Disk file format. ,
VHDX: A VHDX file is a disk image file in the Virtual Hard Disk v2 file format. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
accessSAS:
{
Description: A SAS uri for accessing a disk. ,
Required: False ,
}
string ,
securityDataAccessSAS:
{
Description: A SAS uri for accessing a VM guest state. ,
Required: False ,
}
string ,
securityMetadataAccessSAS:
{
Description: A SAS uri for accessing a VM metadata. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
Disks_RevokeAccess (new)
Description :  Revokes access to a disk.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/endGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
DiskRestorePoint_ListByRestorePoint (new)
Description :  Lists diskRestorePoints under a vmRestorePoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection that the disk restore point belongs. ,
Required: True ,
}
string ,
vmRestorePointName:
{
Description: The name of the vm restore point that the disk disk restore point belongs. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disk restore points. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of an incremental disk restore point ,
Required: False ,
}
{
timeCreated:
{
Description: The timestamp of restorePoint creation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: arm id of source disk or source disk restore point. ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
familyId:
{
Description: id of the backing snapshot's MIS family ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: unique incarnation id of the source disk ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
completionPercent:
{
Description: Percentage complete for the background copy of disk restore point when source resource is from a different region. ,
Required: False ,
}
number ,
replicationState:
{
Description: Replication state of disk restore point when source resource is from a different region. ,
Required: False ,
}
string ,
sourceResourceLocation:
{
Description: Location of source disk or source disk restore point when source resource is from a different region. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
logicalSectorSize:
{
Description: Logical sector size in bytes for disk restore points of UltraSSD_LRS and PremiumV2_LRS disks. Supported values are 512 and 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disk restore points. Call ListNext() with this to fetch the next page of disk restore points. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskRestorePoint_Get (new)
Description :  Get disk restorePoint resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection that the disk restore point belongs. ,
Required: True ,
}
string ,
vmRestorePointName:
{
Description: The name of the vm restore point that the disk disk restore point belongs. ,
Required: True ,
}
string ,
diskRestorePointName:
{
Description: The name of the disk restore point created. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an incremental disk restore point ,
Required: False ,
}
{
timeCreated:
{
Description: The timestamp of restorePoint creation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: arm id of source disk or source disk restore point. ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
familyId:
{
Description: id of the backing snapshot's MIS family ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: unique incarnation id of the source disk ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
completionPercent:
{
Description: Percentage complete for the background copy of disk restore point when source resource is from a different region. ,
Required: False ,
}
number ,
replicationState:
{
Description: Replication state of disk restore point when source resource is from a different region. ,
Required: False ,
}
string ,
sourceResourceLocation:
{
Description: Location of source disk or source disk restore point when source resource is from a different region. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
logicalSectorSize:
{
Description: Logical sector size in bytes for disk restore points of UltraSSD_LRS and PremiumV2_LRS disks. Supported values are 512 and 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskRestorePoint_GrantAccess (new)
Description :  Grants access to a diskRestorePoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}/beginGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection that the disk restore point belongs. ,
Required: True ,
}
string ,
vmRestorePointName:
{
Description: The name of the vm restore point that the disk disk restore point belongs. ,
Required: True ,
}
string ,
diskRestorePointName:
{
Description: The name of the disk restore point created. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
grantAccessData:
{
Description: Access data object supplied in the body of the get disk access operation. ,
Required: True ,
}
{
access:
{
Enum:
{
None: No description available. ,
Read: No description available. ,
Write: No description available. ,
}
,
Required: True ,
}
enum ,
durationInSeconds:
{
Description: Time duration in seconds until the SAS access expires. ,
Format: int32 ,
Required: True ,
}
integer ,
getSecureVMGuestStateSAS:
{
Description: Set this flag to true to get additional SAS for VM guest state ,
Required: False ,
}
boolean ,
fileFormat:
{
Description: Used to specify the file format when making request for SAS on a VHDX file format snapshot ,
Enum:
{
VHD: A VHD file is a disk image file in the Virtual Hard Disk file format. ,
VHDX: A VHDX file is a disk image file in the Virtual Hard Disk v2 file format. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
accessSAS:
{
Description: A SAS uri for accessing a disk. ,
Required: False ,
}
string ,
securityDataAccessSAS:
{
Description: A SAS uri for accessing a VM guest state. ,
Required: False ,
}
string ,
securityMetadataAccessSAS:
{
Description: A SAS uri for accessing a VM metadata. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskRestorePoint_RevokeAccess (new)
Description :  Revokes access to a diskRestorePoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}/endGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection that the disk restore point belongs. ,
Required: True ,
}
string ,
vmRestorePointName:
{
Description: The name of the vm restore point that the disk disk restore point belongs. ,
Required: True ,
}
string ,
diskRestorePointName:
{
Description: The name of the disk restore point created. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Snapshots_ListByResourceGroup (new)
Description :  Lists snapshots under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of snapshots. ,
Required: True ,
}
[
{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots. ,
Required: False ,
}
string ,
}
Snapshots_Get (new)
Description :  Gets information about a snapshot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
Snapshots_CreateOrUpdate (new)
Description :  Creates or updates a snapshot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
snapshot:
{
Description: Snapshot object supplied in the body of the Put disk operation. ,
Required: True ,
}
{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
Snapshots_Update (new)
Description :  Updates (patches) a snapshot.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
snapshot:
{
Description: Snapshot object supplied in the body of the Patch snapshot operation. ,
Required: True ,
}
{
properties:
{
Description: Snapshot resource update properties. ,
Required: False ,
}
{
osType:
{
Description: the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
Snapshots_Delete (new)
Description :  Deletes a snapshot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Snapshots_GrantAccess (new)
Description :  Grants access to a snapshot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/beginGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
grantAccessData:
{
Description: Access data object supplied in the body of the get snapshot access operation. ,
Required: True ,
}
{
access:
{
Enum:
{
None: No description available. ,
Read: No description available. ,
Write: No description available. ,
}
,
Required: True ,
}
enum ,
durationInSeconds:
{
Description: Time duration in seconds until the SAS access expires. ,
Format: int32 ,
Required: True ,
}
integer ,
getSecureVMGuestStateSAS:
{
Description: Set this flag to true to get additional SAS for VM guest state ,
Required: False ,
}
boolean ,
fileFormat:
{
Description: Used to specify the file format when making request for SAS on a VHDX file format snapshot ,
Enum:
{
VHD: A VHD file is a disk image file in the Virtual Hard Disk file format. ,
VHDX: A VHDX file is a disk image file in the Virtual Hard Disk v2 file format. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
accessSAS:
{
Description: A SAS uri for accessing a disk. ,
Required: False ,
}
string ,
securityDataAccessSAS:
{
Description: A SAS uri for accessing a VM guest state. ,
Required: False ,
}
string ,
securityMetadataAccessSAS:
{
Description: A SAS uri for accessing a VM metadata. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
Snapshots_RevokeAccess (new)
Description :  Revokes access to a snapshot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/endGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Disks_CreateOrUpdate (removed)
Description :  Creates or updates a disk.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
disk:
{
Description: Disk object supplied in the body of the Put disk operation. ,
Required: True ,
}
{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
Disks_Update (removed)
Description :  Updates (patches) a disk.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
disk:
{
Description: Disk object supplied in the body of the Patch disk operation. ,
Required: True ,
}
{
properties:
{
Description: Disk resource update properties. ,
Required: False ,
}
{
osType:
{
Description: the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
purchasePlan:
{
Description: Purchase plan information to be added on the OS disk ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities to be added on the OS disk. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
Disks_Get (removed)
Description :  Gets information about a disk.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
Disks_Delete (removed)
Description :  Deletes a disk.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Disks_ListByResourceGroup (removed)
Description :  Lists all the disks under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disks. ,
Required: True ,
}
[
{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks. ,
Required: False ,
}
string ,
}
Disks_List (removed)
Description :  Lists all the disks under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disks. ,
Required: True ,
}
[
{
managedBy:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
managedByExtended:
{
Description: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The Logical zone list for Disk. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location where the disk will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Disk resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the disk was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
diskIOPSReadWrite:
{
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskIOPSReadOnly:
{
Description: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadOnly:
{
Description: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the disk. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
maxShares:
{
Description: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
shareInfo:
{
Description: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs. ,
Required: False ,
}
[
{
vmUri:
{
Description: A relative URI containing the ID of the VM that has the disk attached. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
burstingEnabledTime:
{
Description: Latest time when bursting was last enabled on a disk. ,
Format: date-time ,
Required: False ,
}
string ,
tier:
{
Description: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. ,
Required: False ,
}
string ,
burstingEnabled:
{
Description: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. ,
Required: False ,
}
boolean ,
propertyUpdatesInProgress:
{
Description: Properties of the disk for which update is pending. ,
Required: False ,
}
{
targetTier:
{
Description: The target performance tier of the disk if a tier change operation is in progress. ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
optimizedForFrequentAttach:
{
Description: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. ,
Required: False ,
}
boolean ,
LastOwnershipUpdateTime:
{
Description: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityPolicy:
{
Description: Determines how platform treats disk failures ,
Required: False ,
}
{
actionOnDiskDelay:
{
Description: Determines on how to handle disks with slow I/O. ,
Enum:
{
None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.. ,
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks. ,
Required: False ,
}
string ,
}
Disks_GrantAccess (removed)
Description :  Grants access to a disk.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/beginGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
grantAccessData:
{
Description: Access data object supplied in the body of the get disk access operation. ,
Required: True ,
}
{
access:
{
Enum:
{
None: No description available. ,
Read: No description available. ,
Write: No description available. ,
}
,
Required: True ,
}
enum ,
durationInSeconds:
{
Description: Time duration in seconds until the SAS access expires. ,
Format: int32 ,
Required: True ,
}
integer ,
getSecureVMGuestStateSAS:
{
Description: Set this flag to true to get additional SAS for VM guest state ,
Required: False ,
}
boolean ,
fileFormat:
{
Description: Used to specify the file format when making request for SAS on a VHDX file format snapshot ,
Enum:
{
VHD: A VHD file is a disk image file in the Virtual Hard Disk file format. ,
VHDX: A VHDX file is a disk image file in the Virtual Hard Disk v2 file format. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
accessSAS:
{
Description: A SAS uri for accessing a disk. ,
Required: False ,
}
string ,
securityDataAccessSAS:
{
Description: A SAS uri for accessing a VM guest state. ,
Required: False ,
}
string ,
securityMetadataAccessSAS:
{
Description: A SAS uri for accessing a VM metadata. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
Disks_RevokeAccess (removed)
Description :  Revokes access to a disk.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/endGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskName:
{
Description: The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
DiskAccesses_CreateOrUpdate (removed)
Description :  Creates or updates a disk access resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
diskAccess:
{
Description: disk access object supplied in the body of the Put disk access operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_Update (removed)
Description :  Updates (patches) a disk access resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
diskAccess:
{
Description: disk access object supplied in the body of the Patch disk access operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_Get (removed)
Description :  Gets information about a disk access resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_Delete (removed)
Description :  Deletes a disk access resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_ListByResourceGroup (removed)
Description :  Lists all the disk access resources under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disk access resources. ,
Required: True ,
}
[
{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disk access resources. Call ListNext() with this to fetch the next page of disk access resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_List (removed)
Description :  Lists all the disk access resources under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disk access resources. ,
Required: True ,
}
[
{
properties:
{
Required: False ,
}
{
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk access resource provisioning state. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The time when the disk access was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the disk access will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disk access resources. Call ListNext() with this to fetch the next page of disk access resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_GetPrivateLinkResources (removed)
Description :  Gets the private link resources possible under disk access resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateLinkResources
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: private link resource Id ,
Required: False ,
}
string ,
name:
{
Description: private link resource name ,
Required: False ,
}
string ,
type:
{
Description: private link resource type ,
Required: False ,
}
string ,
}
,
]
,
}
DiskAccesses_UpdateAPrivateEndpointConnection (removed)
Description :  Approve or reject a private endpoint connection under disk access resource, this can't be used to create a new private endpoint connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: private endpoint connection object supplied in the body of the Put private endpoint connection operation. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_GetAPrivateEndpointConnection (removed)
Description :  Gets information about a private endpoint connection under a disk access resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_DeleteAPrivateEndpointConnection (removed)
Description :  Deletes a private endpoint connection under a disk access resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskAccesses_ListPrivateEndpointConnections (removed)
Description :  List information about private endpoint connections under a disk access resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskAccessName:
{
Description: The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between DiskAccess and Virtual Network. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
id:
{
Description: private endpoint connection Id ,
Required: False ,
}
string ,
name:
{
Description: private endpoint connection name ,
Required: False ,
}
string ,
type:
{
Description: private endpoint connection type ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_CreateOrUpdate (removed)
Description :  Creates or updates a disk encryption set
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskEncryptionSetName:
{
Description: The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
diskEncryptionSet:
{
Description: disk encryption set object supplied in the body of the Put disk encryption set operation. ,
Required: True ,
}
{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_Update (removed)
Description :  Updates (patches) a disk encryption set.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskEncryptionSetName:
{
Description: The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
diskEncryptionSet:
{
Description: disk encryption set object supplied in the body of the Patch disk encryption set operation. ,
Required: True ,
}
{
properties:
{
Description: disk encryption set resource update properties. ,
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_Get (removed)
Description :  Gets information about a disk encryption set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskEncryptionSetName:
{
Description: The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_Delete (removed)
Description :  Deletes a disk encryption set.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskEncryptionSetName:
{
Description: The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_ListByResourceGroup (removed)
Description :  Lists all the disk encryption sets under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disk encryption sets. ,
Required: True ,
}
[
{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disk encryption sets. Call ListNext() with this to fetch the next page of disk encryption sets. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_List (removed)
Description :  Lists all the disk encryption sets under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disk encryption sets. ,
Required: True ,
}
[
{
identity:
{
Description: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. ,
Required: False ,
}
{
type:
{
Description: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
encryptionType:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key. ,
}
,
Required: False ,
}
enum ,
activeKey:
{
Description: The key vault key which is currently used by this disk encryption set. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
previousKeys:
{
Description: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. ,
Required: False ,
}
[
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The disk encryption set provisioning state. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: The time when the active key of this disk encryption set was updated. ,
Format: date-time ,
Required: False ,
}
string ,
autoKeyRotationError:
{
Description: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
federatedClientId:
{
Description: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disk encryption sets. Call ListNext() with this to fetch the next page of disk encryption sets. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskEncryptionSets_ListAssociatedResources (removed)
Description :  Lists all resources that are encrypted with this disk encryption set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}/associatedResources
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
diskEncryptionSetName:
{
Description: The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of IDs or Owner IDs of resources which are encrypted with the disk encryption set. ,
Required: True ,
}
[
string ,
]
,
nextLink:
{
Description: The uri to fetch the next page of encrypted resources. Call ListNext() with this to fetch the next page of encrypted resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskRestorePoint_Get (removed)
Description :  Get disk restorePoint resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection that the disk restore point belongs. ,
Required: True ,
}
string ,
vmRestorePointName:
{
Description: The name of the vm restore point that the disk disk restore point belongs. ,
Required: True ,
}
string ,
diskRestorePointName:
{
Description: The name of the disk restore point created. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an incremental disk restore point ,
Required: False ,
}
{
timeCreated:
{
Description: The timestamp of restorePoint creation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: arm id of source disk or source disk restore point. ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
familyId:
{
Description: id of the backing snapshot's MIS family ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: unique incarnation id of the source disk ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
completionPercent:
{
Description: Percentage complete for the background copy of disk restore point when source resource is from a different region. ,
Required: False ,
}
number ,
replicationState:
{
Description: Replication state of disk restore point when source resource is from a different region. ,
Required: False ,
}
string ,
sourceResourceLocation:
{
Description: Location of source disk or source disk restore point when source resource is from a different region. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
logicalSectorSize:
{
Description: Logical sector size in bytes for disk restore points of UltraSSD_LRS and PremiumV2_LRS disks. Supported values are 512 and 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskRestorePoint_ListByRestorePoint (removed)
Description :  Lists diskRestorePoints under a vmRestorePoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection that the disk restore point belongs. ,
Required: True ,
}
string ,
vmRestorePointName:
{
Description: The name of the vm restore point that the disk disk restore point belongs. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of disk restore points. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of an incremental disk restore point ,
Required: False ,
}
{
timeCreated:
{
Description: The timestamp of restorePoint creation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: arm id of source disk or source disk restore point. ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the the image from which the OS disk was created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
familyId:
{
Description: id of the backing snapshot's MIS family ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: unique incarnation id of the source disk ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a disk supports hibernation. ,
Required: False ,
}
boolean ,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
completionPercent:
{
Description: Percentage complete for the background copy of disk restore point when source resource is from a different region. ,
Required: False ,
}
number ,
replicationState:
{
Description: Replication state of disk restore point when source resource is from a different region. ,
Required: False ,
}
string ,
sourceResourceLocation:
{
Description: Location of source disk or source disk restore point when source resource is from a different region. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
logicalSectorSize:
{
Description: Logical sector size in bytes for disk restore points of UltraSSD_LRS and PremiumV2_LRS disks. Supported values are 512 and 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of disk restore points. Call ListNext() with this to fetch the next page of disk restore points. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskRestorePoint_GrantAccess (removed)
Description :  Grants access to a diskRestorePoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}/beginGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection that the disk restore point belongs. ,
Required: True ,
}
string ,
vmRestorePointName:
{
Description: The name of the vm restore point that the disk disk restore point belongs. ,
Required: True ,
}
string ,
diskRestorePointName:
{
Description: The name of the disk restore point created. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
grantAccessData:
{
Description: Access data object supplied in the body of the get disk access operation. ,
Required: True ,
}
{
access:
{
Enum:
{
None: No description available. ,
Read: No description available. ,
Write: No description available. ,
}
,
Required: True ,
}
enum ,
durationInSeconds:
{
Description: Time duration in seconds until the SAS access expires. ,
Format: int32 ,
Required: True ,
}
integer ,
getSecureVMGuestStateSAS:
{
Description: Set this flag to true to get additional SAS for VM guest state ,
Required: False ,
}
boolean ,
fileFormat:
{
Description: Used to specify the file format when making request for SAS on a VHDX file format snapshot ,
Enum:
{
VHD: A VHD file is a disk image file in the Virtual Hard Disk file format. ,
VHDX: A VHDX file is a disk image file in the Virtual Hard Disk v2 file format. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
accessSAS:
{
Description: A SAS uri for accessing a disk. ,
Required: False ,
}
string ,
securityDataAccessSAS:
{
Description: A SAS uri for accessing a VM guest state. ,
Required: False ,
}
string ,
securityMetadataAccessSAS:
{
Description: A SAS uri for accessing a VM metadata. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DiskRestorePoint_RevokeAccess (removed)
Description :  Revokes access to a diskRestorePoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}/endGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection that the disk restore point belongs. ,
Required: True ,
}
string ,
vmRestorePointName:
{
Description: The name of the vm restore point that the disk disk restore point belongs. ,
Required: True ,
}
string ,
diskRestorePointName:
{
Description: The name of the disk restore point created. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Snapshots_CreateOrUpdate (removed)
Description :  Creates or updates a snapshot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
snapshot:
{
Description: Snapshot object supplied in the body of the Put disk operation. ,
Required: True ,
}
{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
Snapshots_Update (removed)
Description :  Updates (patches) a snapshot.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
snapshot:
{
Description: Snapshot object supplied in the body of the Patch snapshot operation. ,
Required: True ,
}
{
properties:
{
Description: Snapshot resource update properties. ,
Required: False ,
}
{
osType:
{
Description: the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the OS disk was created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
Snapshots_Get (removed)
Description :  Gets information about a snapshot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
Snapshots_Delete (removed)
Description :  Deletes a snapshot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Snapshots_ListByResourceGroup (removed)
Description :  Lists snapshots under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of snapshots. ,
Required: True ,
}
[
{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots. ,
Required: False ,
}
string ,
}
Snapshots_List (removed)
Description :  Lists snapshots under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/snapshots
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of snapshots. ,
Required: True ,
}
[
{
managedBy:
{
Description: Unused. Always Null. ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage ,
Premium_LRS: Premium SSD locally redundant storage ,
Standard_ZRS: Standard zone redundant storage ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extended location where the snapshot will be created. Extended location cannot be changed. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Snapshot resource properties. ,
Required: False ,
}
{
timeCreated:
{
Description: The time when the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
purchasePlan:
{
Description: Purchase plan information for the image from which the source disk for the snapshot was originally created. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The Offer Promotion Code. ,
Required: False ,
}
string ,
}
,
supportedCapabilities:
{
Description: List of supported capabilities for the image from which the source disk from the snapshot was originally created. ,
Required: False ,
}
{
diskControllerTypes:
{
Description: The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. ,
Required: False ,
}
string ,
acceleratedNetwork:
{
Description: True if the image from which the OS disk is created supports accelerated networking. ,
Required: False ,
}
boolean ,
architecture:
{
Description: CPU architecture supported by an OS disk. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
supportedSecurityOption:
{
Description: Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM ,
Enum:
{
TrustedLaunchSupported: No description available. ,
TrustedLaunchAndConfidentialVMSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
creationData:
{
Description: Disk source information. CreationData information cannot be changed after the disk has been created. ,
Required: True ,
}
{
createOption:
{
Description: This enumerates the possible sources of a disk's creation. ,
Enum:
{
Empty: Create an empty data disk of a size given by diskSizeGB. ,
Attach: Disk will be attached to a VM. ,
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. ,
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. ,
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. ,
Restore: Create a new disk by copying from a backup recovery point. ,
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. ,
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. ,
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. ,
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot ,
}
,
Required: True ,
}
enum ,
storageAccountId:
{
Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. ,
Required: False ,
}
string ,
imageReference:
{
Description: Disk source information for PIR or user images. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: A relative uri containing a direct shared Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: A relative uri containing a community Azure Compute Gallery image reference. ,
Required: False ,
}
string ,
lun:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceUri:
{
Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk. ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: If createOption is Copy, this is the ARM id of the source snapshot or disk. ,
Required: False ,
}
string ,
sourceUniqueId:
{
Description: If this field is set, this is the unique id identifying the source of this resource. ,
Required: False ,
}
string ,
uploadSizeBytes:
{
Description: 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). ,
Format: int64 ,
Required: False ,
}
integer ,
logicalSectorSize:
{
Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. ,
Format: int32 ,
Required: False ,
}
integer ,
securityDataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. ,
Required: False ,
}
string ,
performancePlus:
{
Description: 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. ,
Required: False ,
}
boolean ,
elasticSanResourceId:
{
Description: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. ,
Required: False ,
}
string ,
provisionedBandwidthCopySpeed:
{
Description: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. ,
Enum:
{
None: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
instantAccessDurationMinutes:
{
Description: “For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. ,
Format: int64 ,
Required: False ,
}
integer ,
securityMetadataUri:
{
Description: If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. ,
Format: uri ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeBytes:
{
Description: The size of the disk in bytes. This field is read only. ,
Format: int64 ,
Required: False ,
}
integer ,
diskState:
{
Description: The state of the snapshot. ,
Enum:
{
Unattached: The disk is not being used and can be attached to a VM. ,
Attached: The disk is currently attached to a running VM. ,
Reserved: The disk is attached to a stopped-deallocated VM. ,
Frozen: The disk is attached to a VM which is in hibernated state. ,
ActiveSAS: The disk currently has an Active SAS Uri associated with it. ,
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. ,
ReadyToUpload: A disk is ready to be created by upload by requesting a write token. ,
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it. ,
}
,
Required: False ,
}
enum ,
uniqueId:
{
Description: Unique Guid identifying the resource. ,
Required: False ,
}
string ,
encryptionSettingsCollection:
{
Description: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. ,
Required: False ,
}
{
enabled:
{
Description: 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. ,
Required: True ,
}
boolean ,
encryptionSettings:
{
Description: A collection of encryption settings, one for each disk volume. ,
Required: False ,
}
[
{
diskEncryptionKey:
{
Description: Key Vault Secret Url and vault id of the disk encryption key ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
keyEncryptionKey:
{
Description: Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: Resource id of the KeyVault containing the key or secret ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: Url pointing to a key or secret in KeyVault ,
Required: True ,
}
string ,
}
,
}
,
]
,
encryptionSettingsVersion:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The disk provisioning state. ,
Required: False ,
}
string ,
incremental:
{
Description: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. ,
Required: False ,
}
boolean ,
incrementalSnapshotFamilyId:
{
Description: 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. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. ,
Required: False ,
}
{
diskEncryptionSetId:
{
Description: ResourceId of the disk encryption set to use for enabling encryption at rest. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. ,
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
networkAccessPolicy:
{
Description: Policy for accessing the disk via network. ,
Enum:
{
AllowAll: The disk can be exported or uploaded to from any network. ,
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. ,
DenyAll: The disk cannot be exported. ,
}
,
Required: False ,
}
enum ,
diskAccessId:
{
Description: ARM id of the DiskAccess resource for using private endpoints on disks. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Contains the security related information for the resource. ,
Required: False ,
}
{
securityType:
{
Description: Specifies the SecurityType of the VM. Applicable for OS disks only. ,
Enum:
{
TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) ,
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted ,
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key ,
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key ,
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. ,
}
,
Required: False ,
}
enum ,
secureVMDiskEncryptionSetId:
{
Description: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key ,
Required: False ,
}
string ,
}
,
supportsHibernation:
{
Description: Indicates the OS on a snapshot supports hibernation. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Policy for controlling export on the disk. ,
Enum:
{
Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. ,
}
,
Required: False ,
}
enum ,
completionPercent:
{
Description: Percentage complete for the background copy when a resource is created via the CopyStart operation. ,
Required: False ,
}
number ,
copyCompletionError:
{
Description: Indicates the error details if the background copy of a resource created via the CopyStart operation fails. ,
Required: False ,
}
{
errorCode:
{
Description: Indicates the error code if the background copy of a resource created via the CopyStart operation fails. ,
Enum:
{
CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: Indicates the error message if the background copy of a resource created via the CopyStart operation fails. ,
Required: True ,
}
string ,
}
,
dataAccessAuthMode:
{
Description: Additional authentication requirements when exporting or uploading to a disk or snapshot. ,
Enum:
{
AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. ,
None: No additional authentication would be performed when accessing export/upload URL. ,
}
,
Required: False ,
}
enum ,
snapshotAccessState:
{
Description: The state of snapshot which determines the access availability of the snapshot. ,
Enum:
{
Unknown: Default value. ,
Pending: The snapshot cannot be used for restore, copy or download to offline. ,
Available: The snapshot can be used for restore, copy to different region, and download to offline. ,
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. ,
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots. ,
Required: False ,
}
string ,
}
Snapshots_GrantAccess (removed)
Description :  Grants access to a snapshot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/beginGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
grantAccessData:
{
Description: Access data object supplied in the body of the get snapshot access operation. ,
Required: True ,
}
{
access:
{
Enum:
{
None: No description available. ,
Read: No description available. ,
Write: No description available. ,
}
,
Required: True ,
}
enum ,
durationInSeconds:
{
Description: Time duration in seconds until the SAS access expires. ,
Format: int32 ,
Required: True ,
}
integer ,
getSecureVMGuestStateSAS:
{
Description: Set this flag to true to get additional SAS for VM guest state ,
Required: False ,
}
boolean ,
fileFormat:
{
Description: Used to specify the file format when making request for SAS on a VHDX file format snapshot ,
Enum:
{
VHD: A VHD file is a disk image file in the Virtual Hard Disk file format. ,
VHDX: A VHDX file is a disk image file in the Virtual Hard Disk v2 file format. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
accessSAS:
{
Description: A SAS uri for accessing a disk. ,
Required: False ,
}
string ,
securityDataAccessSAS:
{
Description: A SAS uri for accessing a VM guest state. ,
Required: False ,
}
string ,
securityMetadataAccessSAS:
{
Description: A SAS uri for accessing a VM metadata. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
Snapshots_RevokeAccess (removed)
Description :  Revokes access to a snapshot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/endGetAccess
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
snapshotName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}