Microsoft.Compute disks 2019-11-01
Bicep resource definition
The disks resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/disks resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Compute/disks@2019-11-01' = {
location: 'string'
name: 'string'
properties: {
creationData: {
createOption: 'string'
galleryImageReference: {
id: 'string'
lun: int
}
imageReference: {
id: 'string'
lun: int
}
sourceResourceId: 'string'
sourceUri: 'string'
storageAccountId: 'string'
uploadSizeBytes: int
}
diskIOPSReadOnly: int
diskIOPSReadWrite: int
diskMBpsReadOnly: int
diskMBpsReadWrite: int
diskSizeGB: int
encryption: {
diskEncryptionSetId: 'string'
type: 'string'
}
encryptionSettingsCollection: {
enabled: bool
encryptionSettings: [
{
diskEncryptionKey: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
keyEncryptionKey: {
keyUrl: 'string'
sourceVault: {
id: 'string'
}
}
}
]
encryptionSettingsVersion: 'string'
}
hyperVGeneration: 'string'
maxShares: int
osType: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
zones: [
'string'
]
}
Property values
CreationData
| Name | Description | Value |
|---|---|---|
| createOption | This enumerates the possible sources of a disk's creation. | 'Attach' 'Copy' 'Empty' 'FromImage' 'Import' 'Restore' 'Upload' (required) |
| galleryImageReference | 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 |
| imageReference | Disk source information. | ImageDiskReference |
| sourceResourceId | If createOption is Copy, this is the ARM id of the source snapshot or disk. | string |
| sourceUri | If createOption is Import, this is the URI of a blob to be imported into a managed disk. | string |
| storageAccountId | Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. | string |
| uploadSizeBytes | 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). | int |
DiskProperties
| Name | Description | Value |
|---|---|---|
| creationData | Disk source information. CreationData information cannot be changed after the disk has been created. | CreationData (required) |
| diskIOPSReadOnly | 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. | int |
| diskIOPSReadWrite | The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. | int |
| diskMBpsReadOnly | 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. | int |
| diskMBpsReadWrite | 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. | int |
| diskSizeGB | 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. | int |
| encryption | Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. | Encryption |
| encryptionSettingsCollection | Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. | EncryptionSettingsCollection |
| hyperVGeneration | The hypervisor generation of the Virtual Machine. Applicable to OS disks only. | 'V1' 'V2' |
| maxShares | 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. | int |
| osType | The Operating System type. | 'Linux' 'Windows' |
DiskSku
| Name | Description | Value |
|---|---|---|
| name | The sku name. | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'UltraSSD_LRS' |
Encryption
| Name | Description | Value |
|---|---|---|
| diskEncryptionSetId | ResourceId of the disk encryption set to use for enabling encryption at rest. | string |
| type | The type of key used to encrypt the data of the disk. | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
| Name | Description | Value |
|---|---|---|
| enabled | 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. | bool (required) |
| encryptionSettings | A collection of encryption settings, one for each disk volume. | EncryptionSettingsElement[] |
| encryptionSettingsVersion | 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. | string |
EncryptionSettingsElement
| Name | Description | Value |
|---|---|---|
| diskEncryptionKey | Key Vault Secret Url and vault id of the disk encryption key | KeyVaultAndSecretReference |
| keyEncryptionKey | 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 |
ImageDiskReference
| Name | Description | Value |
|---|---|---|
| id | A relative uri containing either a Platform Image Repository or user image reference. | string (required) |
| lun | 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. | int |
KeyVaultAndKeyReference
| Name | Description | Value |
|---|---|---|
| keyUrl | Url pointing to a key or secret in KeyVault | string (required) |
| sourceVault | Resource id of the KeyVault containing the key or secret | SourceVault (required) |
KeyVaultAndSecretReference
| Name | Description | Value |
|---|---|---|
| secretUrl | Url pointing to a key or secret in KeyVault | string (required) |
| sourceVault | Resource id of the KeyVault containing the key or secret | SourceVault (required) |
Microsoft.Compute/disks
| Name | Description | Value |
|---|---|---|
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Disk resource properties. | DiskProperties |
| sku | The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS. | DiskSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| zones | The Logical zone list for Disk. | string[] |
ResourceTags
| Name | Description | Value |
|---|
SourceVault
| Name | Description | Value |
|---|---|---|
| id | Resource Id | string |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Create Disk & enable protection via Backup Vault | Template that creates a disk and enables protection via Backup Vault |
| Windows Docker Host with Portainer and Traefik pre-installed | Windows Docker Host with Portainer and Traefik pre-installed |
| Windows Server VM with SSH | Deploy a single Windows VM with Open SSH enabled so that you can connect through SSH using key-based authentication. |
ARM template resource definition
The disks resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/disks resource, add the following JSON to your template.
{
"type": "Microsoft.Compute/disks",
"apiVersion": "2019-11-01",
"name": "string",
"location": "string",
"properties": {
"creationData": {
"createOption": "string",
"galleryImageReference": {
"id": "string",
"lun": "int"
},
"imageReference": {
"id": "string",
"lun": "int"
},
"sourceResourceId": "string",
"sourceUri": "string",
"storageAccountId": "string",
"uploadSizeBytes": "int"
},
"diskIOPSReadOnly": "int",
"diskIOPSReadWrite": "int",
"diskMBpsReadOnly": "int",
"diskMBpsReadWrite": "int",
"diskSizeGB": "int",
"encryption": {
"diskEncryptionSetId": "string",
"type": "string"
},
"encryptionSettingsCollection": {
"enabled": "bool",
"encryptionSettings": [
{
"diskEncryptionKey": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"keyEncryptionKey": {
"keyUrl": "string",
"sourceVault": {
"id": "string"
}
}
}
],
"encryptionSettingsVersion": "string"
},
"hyperVGeneration": "string",
"maxShares": "int",
"osType": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
},
"zones": [ "string" ]
}
Property values
CreationData
| Name | Description | Value |
|---|---|---|
| createOption | This enumerates the possible sources of a disk's creation. | 'Attach' 'Copy' 'Empty' 'FromImage' 'Import' 'Restore' 'Upload' (required) |
| galleryImageReference | 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 |
| imageReference | Disk source information. | ImageDiskReference |
| sourceResourceId | If createOption is Copy, this is the ARM id of the source snapshot or disk. | string |
| sourceUri | If createOption is Import, this is the URI of a blob to be imported into a managed disk. | string |
| storageAccountId | Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. | string |
| uploadSizeBytes | 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). | int |
DiskProperties
| Name | Description | Value |
|---|---|---|
| creationData | Disk source information. CreationData information cannot be changed after the disk has been created. | CreationData (required) |
| diskIOPSReadOnly | 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. | int |
| diskIOPSReadWrite | The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. | int |
| diskMBpsReadOnly | 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. | int |
| diskMBpsReadWrite | 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. | int |
| diskSizeGB | 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. | int |
| encryption | Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. | Encryption |
| encryptionSettingsCollection | Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. | EncryptionSettingsCollection |
| hyperVGeneration | The hypervisor generation of the Virtual Machine. Applicable to OS disks only. | 'V1' 'V2' |
| maxShares | 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. | int |
| osType | The Operating System type. | 'Linux' 'Windows' |
DiskSku
| Name | Description | Value |
|---|---|---|
| name | The sku name. | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'UltraSSD_LRS' |
Encryption
| Name | Description | Value |
|---|---|---|
| diskEncryptionSetId | ResourceId of the disk encryption set to use for enabling encryption at rest. | string |
| type | The type of key used to encrypt the data of the disk. | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
| Name | Description | Value |
|---|---|---|
| enabled | 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. | bool (required) |
| encryptionSettings | A collection of encryption settings, one for each disk volume. | EncryptionSettingsElement[] |
| encryptionSettingsVersion | 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. | string |
EncryptionSettingsElement
| Name | Description | Value |
|---|---|---|
| diskEncryptionKey | Key Vault Secret Url and vault id of the disk encryption key | KeyVaultAndSecretReference |
| keyEncryptionKey | 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 |
ImageDiskReference
| Name | Description | Value |
|---|---|---|
| id | A relative uri containing either a Platform Image Repository or user image reference. | string (required) |
| lun | 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. | int |
KeyVaultAndKeyReference
| Name | Description | Value |
|---|---|---|
| keyUrl | Url pointing to a key or secret in KeyVault | string (required) |
| sourceVault | Resource id of the KeyVault containing the key or secret | SourceVault (required) |
KeyVaultAndSecretReference
| Name | Description | Value |
|---|---|---|
| secretUrl | Url pointing to a key or secret in KeyVault | string (required) |
| sourceVault | Resource id of the KeyVault containing the key or secret | SourceVault (required) |
Microsoft.Compute/disks
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2019-11-01' |
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Disk resource properties. | DiskProperties |
| sku | The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS. | DiskSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Compute/disks' |
| zones | The Logical zone list for Disk. | string[] |
ResourceTags
| Name | Description | Value |
|---|
SourceVault
| Name | Description | Value |
|---|---|---|
| id | Resource Id | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a VM from a EfficientIP VHD |
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 |
| Create a VM in a new or existing vnet from a custom VHD |
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 |
| Create Disk & enable protection via Backup Vault |
Template that creates a disk and enables protection via Backup Vault |
| Create VM from existing VHDs and connect it to existingVNET |
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 |
| Creates an ultra managed disk with a specific sector size |
This template creates a new ultra managed disk allowing the user to specify a sector size of either 512 or 4096. |
| Deploy a 3 node Percona XtraDB Cluster in Availability Zones |
This template deploys a 3 node MySQL high availability cluster on CentOS 6.5 or Ubuntu 12.04 |
| SQL VM Performance Optimized Storage Settings on UltraSSD |
Create a SQL Server Virtual Machine with performance optimized storage settings, using UltraSSD for SQL Log files |
| Windows Docker Host with Portainer and Traefik pre-installed |
Windows Docker Host with Portainer and Traefik pre-installed |
| Windows Server VM with SSH |
Deploy a single Windows VM with Open SSH enabled so that you can connect through SSH using key-based authentication. |
Terraform (AzAPI provider) resource definition
The disks resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/disks resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/disks@2019-11-01"
name = "string"
location = "string"
sku = {
name = "string"
}
tags = {
{customized property} = "string"
}
zones = [
"string"
]
body = jsonencode({
properties = {
creationData = {
createOption = "string"
galleryImageReference = {
id = "string"
lun = int
}
imageReference = {
id = "string"
lun = int
}
sourceResourceId = "string"
sourceUri = "string"
storageAccountId = "string"
uploadSizeBytes = int
}
diskIOPSReadOnly = int
diskIOPSReadWrite = int
diskMBpsReadOnly = int
diskMBpsReadWrite = int
diskSizeGB = int
encryption = {
diskEncryptionSetId = "string"
type = "string"
}
encryptionSettingsCollection = {
enabled = bool
encryptionSettings = [
{
diskEncryptionKey = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
keyEncryptionKey = {
keyUrl = "string"
sourceVault = {
id = "string"
}
}
}
]
encryptionSettingsVersion = "string"
}
hyperVGeneration = "string"
maxShares = int
osType = "string"
}
})
}
Property values
CreationData
| Name | Description | Value |
|---|---|---|
| createOption | This enumerates the possible sources of a disk's creation. | 'Attach' 'Copy' 'Empty' 'FromImage' 'Import' 'Restore' 'Upload' (required) |
| galleryImageReference | 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 |
| imageReference | Disk source information. | ImageDiskReference |
| sourceResourceId | If createOption is Copy, this is the ARM id of the source snapshot or disk. | string |
| sourceUri | If createOption is Import, this is the URI of a blob to be imported into a managed disk. | string |
| storageAccountId | Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. | string |
| uploadSizeBytes | 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). | int |
DiskProperties
| Name | Description | Value |
|---|---|---|
| creationData | Disk source information. CreationData information cannot be changed after the disk has been created. | CreationData (required) |
| diskIOPSReadOnly | 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. | int |
| diskIOPSReadWrite | The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. | int |
| diskMBpsReadOnly | 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. | int |
| diskMBpsReadWrite | 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. | int |
| diskSizeGB | 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. | int |
| encryption | Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. | Encryption |
| encryptionSettingsCollection | Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. | EncryptionSettingsCollection |
| hyperVGeneration | The hypervisor generation of the Virtual Machine. Applicable to OS disks only. | 'V1' 'V2' |
| maxShares | 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. | int |
| osType | The Operating System type. | 'Linux' 'Windows' |
DiskSku
| Name | Description | Value |
|---|---|---|
| name | The sku name. | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' 'UltraSSD_LRS' |
Encryption
| Name | Description | Value |
|---|---|---|
| diskEncryptionSetId | ResourceId of the disk encryption set to use for enabling encryption at rest. | string |
| type | The type of key used to encrypt the data of the disk. | 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformKey' |
EncryptionSettingsCollection
| Name | Description | Value |
|---|---|---|
| enabled | 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. | bool (required) |
| encryptionSettings | A collection of encryption settings, one for each disk volume. | EncryptionSettingsElement[] |
| encryptionSettingsVersion | 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. | string |
EncryptionSettingsElement
| Name | Description | Value |
|---|---|---|
| diskEncryptionKey | Key Vault Secret Url and vault id of the disk encryption key | KeyVaultAndSecretReference |
| keyEncryptionKey | 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 |
ImageDiskReference
| Name | Description | Value |
|---|---|---|
| id | A relative uri containing either a Platform Image Repository or user image reference. | string (required) |
| lun | 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. | int |
KeyVaultAndKeyReference
| Name | Description | Value |
|---|---|---|
| keyUrl | Url pointing to a key or secret in KeyVault | string (required) |
| sourceVault | Resource id of the KeyVault containing the key or secret | SourceVault (required) |
KeyVaultAndSecretReference
| Name | Description | Value |
|---|---|---|
| secretUrl | Url pointing to a key or secret in KeyVault | string (required) |
| sourceVault | Resource id of the KeyVault containing the key or secret | SourceVault (required) |
Microsoft.Compute/disks
| Name | Description | Value |
|---|---|---|
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Disk resource properties. | DiskProperties |
| sku | The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS. | DiskSku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Compute/disks@2019-11-01" |
| zones | The Logical zone list for Disk. | string[] |
ResourceTags
| Name | Description | Value |
|---|
SourceVault
| Name | Description | Value |
|---|---|---|
| id | Resource Id | string |