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

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.

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

The name of the resource group.

Default value: "application/json"

Resource Id

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.

The complex type of the extended location.

The name of the extended location.

The type of extendedLocation.

Possible values:

• "EdgeZone"

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.

The sku tier.

The sku name.

Possible values:

• "PremiumV2_LRS"
• "UltraSSD_LRS"
• "StandardSSD_LRS"
• "Standard_LRS"
• "Premium_ZRS"
• "StandardSSD_ZRS"
• "Premium_LRS"

Resource name

Disk resource properties.

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

Possible values:

• "None"
• "AzureActiveDirectory"

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.

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

This enumerates the possible state of the disk.

Possible values:

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

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.

A relative URI containing the ID of the VM that has the disk attached.

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

The time when the disk was created.

The Operating System type.

Possible values:

• "Windows"
• "Linux"

The disk provisioning state.

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

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

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

CPU architecture supported by an OS disk.

Possible values:

• "x64"
• "Arm64"

Data used when creating a disk.

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

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

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

The source image used for creating the disk.

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

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

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

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

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

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

Possible values:

• "Enhanced"
• "None"

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

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

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

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

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

Possible values:

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

The source image used for creating the disk.

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

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

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

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

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

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.

Encryption settings for disk or snapshot

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

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

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

Resource Id

Url pointing to a key or secret in KeyVault

Key Vault Secret Url and vault id of the encryption key

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

Resource Id

Url pointing to a key or secret in KeyVault

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

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

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.

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.

Contains the security related information for the resource.

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

Possible values:

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

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

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

Properties of the disk for which update is pending.

The target performance tier of the disk if a tier change operation is in progress.

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.

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.

Indicates the OS on a disk supports hibernation.

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

The plan ID.

The publisher ID.

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

The Offer Promotion Code.

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.

Encryption at rest settings for disk or snapshot

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

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

Possible values:

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

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

Unique Guid identifying the resource.

The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

Latest time when bursting was last enabled on a disk.

Policy for controlling export on the disk.

Possible values:

• "Disabled"
• "Enabled"

Policy for accessing the disk via network.

Possible values:

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

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

Possible values:

• "V2"
• "V1"

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.

Resource location

The Logical zone list for Disk.

A relative URI containing the ID of the VM that has the disk attached.

Resource tags

Resource type