The following tables describe the values you need to set in the schema.
Microsoft.Compute/disks object
Name
Type
Required
Value
name
string
Yes
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.
The sku name. - Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS
ExtendedLocation object
Name
Type
Required
Value
name
string
No
The name of the extended location.
type
enum
No
The type of the extended location. - EdgeZone
DiskProperties object
Name
Type
Required
Value
osType
enum
No
The Operating System type. - Windows or Linux
hyperVGeneration
enum
No
The hypervisor generation of the Virtual Machine. Applicable to OS disks only. - V1 or V2
purchasePlan
object
No
Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} - PurchasePlan object
creationData
object
Yes
Disk source information. CreationData information cannot be changed after the disk has been created. - CreationData object
diskSizeGB
integer
No
If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
encryptionSettingsCollection
object
No
Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. - EncryptionSettingsCollection object
diskIOPSReadWrite
integer
No
The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
diskMBpsReadWrite
integer
No
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.
diskIOPSReadOnly
integer
No
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.
diskMBpsReadOnly
integer
No
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.
diskState
enum
No
The state of the disk. - Unattached, Attached, Reserved, ActiveSAS, ReadyToUpload, ActiveUpload
encryption
object
No
Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. - Encryption object
maxShares
integer
No
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.
networkAccessPolicy
enum
No
AllowAll, AllowPrivate, DenyAll
diskAccessId
string
No
ARM id of the DiskAccess resource for using private endpoints on disks.
Required if creating from a Gallery Image. The id of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. - ImageDiskReference object
sourceUri
string
No
If createOption is Import, this is the URI of a blob to be imported into a managed disk.
sourceResourceId
string
No
If createOption is Copy, this is the ARM id of the source snapshot or disk.
uploadSizeBytes
integer
No
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).
logicalSectorSize
integer
No
Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
EncryptionSettingsCollection object
Name
Type
Required
Value
enabled
boolean
Yes
Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
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.
Encryption object
Name
Type
Required
Value
diskEncryptionSetId
string
No
ResourceId of the disk encryption set to use for enabling encryption at rest.
A relative uri containing either a Platform Image Repository or user image reference.
lun
integer
No
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.
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. - KeyVaultAndKeyReference object
KeyVaultAndSecretReference object
Name
Type
Required
Value
sourceVault
object
Yes
Resource id of the KeyVault containing the key or secret - SourceVault object
secretUrl
string
Yes
Url pointing to a key or secret in KeyVault
KeyVaultAndKeyReference object
Name
Type
Required
Value
sourceVault
object
Yes
Resource id of the KeyVault containing the key or secret - SourceVault object
keyUrl
string
Yes
Url pointing to a key or secret in KeyVault
SourceVault object
Name
Type
Required
Value
id
string
No
Resource Id
Quickstart templates
The following quickstart templates deploy this resource type.
This template creates a VM from a EfficientIP VHD and let you connect it to an existing VNET that can reside in another Resource Group then the virtual machine
This template creates a VM from VHDs (OS + data disk) and let you connect it to an existing VNET that can reside in another Resource Group then the virtual machine
This template creates a VM from a specialized VHD and let you connect it to a new or existing VNET that can reside in another Resource Group than the virtual machine