Microsoft.Compute disks 2023-10-02

Article
12/09/2024

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@2023-10-02' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    burstingEnabled: bool
    completionPercent: int
    creationData: {
      createOption: 'string'
      elasticSanResourceId: 'string'
      galleryImageReference: {
        communityGalleryImageId: 'string'
        id: 'string'
        lun: int
        sharedGalleryImageId: 'string'
      }
      imageReference: {
        communityGalleryImageId: 'string'
        id: 'string'
        lun: int
        sharedGalleryImageId: 'string'
      }
      logicalSectorSize: int
      performancePlus: bool
      provisionedBandwidthCopySpeed: 'string'
      securityDataUri: 'string'
      sourceResourceId: 'string'
      sourceUri: 'string'
      storageAccountId: 'string'
      uploadSizeBytes: int
    }
    dataAccessAuthMode: 'string'
    diskAccessId: 'string'
    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
    networkAccessPolicy: 'string'
    optimizedForFrequentAttach: bool
    osType: 'string'
    publicNetworkAccess: 'string'
    purchasePlan: {
      name: 'string'
      product: 'string'
      promotionCode: 'string'
      publisher: 'string'
    }
    securityProfile: {
      secureVMDiskEncryptionSetId: 'string'
      securityType: 'string'
    }
    supportedCapabilities: {
      acceleratedNetwork: bool
      architecture: 'string'
      diskControllerTypes: 'string'
    }
    supportsHibernation: bool
    tier: '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' 'CopyFromSanSnapshot' 'CopyStart' 'Empty' 'FromImage' 'Import' 'ImportSecure' 'Restore' 'Upload' 'UploadPreparedSecure' (required)
elasticSanResourceId	Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.	string
galleryImageReference	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.	ImageDiskReference
imageReference	Disk source information for PIR or user images.	ImageDiskReference
logicalSectorSize	Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.	int
performancePlus	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.	bool
provisionedBandwidthCopySpeed	If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.	'Enhanced' 'None'
securityDataUri	If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.	string
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
burstingEnabled	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.	bool
completionPercent	Percentage complete for the background copy when a resource is created via the CopyStart operation.	int
creationData	Disk source information. CreationData information cannot be changed after the disk has been created.	CreationData (required)
dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.	'AzureActiveDirectory' 'None'
diskAccessId	ARM id of the DiskAccess resource for using private endpoints on disks.	string
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
networkAccessPolicy	Policy for accessing the disk via network.	'AllowAll' 'AllowPrivate' 'DenyAll'
optimizedForFrequentAttach	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.	bool
osType	The Operating System type.	'Linux' 'Windows'
publicNetworkAccess	Policy for controlling export on the disk.	'Disabled' 'Enabled'
purchasePlan	Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}	PurchasePlan
securityProfile	Contains the security related information for the resource.	DiskSecurityProfile
supportedCapabilities	List of supported capabilities for the image from which the OS disk was created.	SupportedCapabilities
supportsHibernation	Indicates the OS on a disk supports hibernation.	bool
tier	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.	string

DiskSecurityProfile

Name	Description	Value
secureVMDiskEncryptionSetId	ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key	string
securityType	Specifies the SecurityType of the VM. Applicable for OS disks only.	'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_NonPersistedTPM' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch'

DiskSku

Name	Description	Value
name	The sku name.	'PremiumV2_LRS' 'Premium_LRS' 'Premium_ZRS' 'StandardSSD_LRS' 'StandardSSD_ZRS' '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' 'EncryptionAtRestWithPlatformAndCustomerKeys' '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

ExtendedLocation

Name	Description	Value
name	The name of the extended location.	string
type	The type of the extended location.	'EdgeZone'

ImageDiskReference

Name	Description	Value
communityGalleryImageId	A relative uri containing a community Azure Compute Gallery image reference.	string
id	A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.	string
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
sharedGalleryImageId	A relative uri containing a direct shared Azure Compute Gallery image reference.	string

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
extendedLocation	The extended location where the disk will be created. Extended location cannot be changed.	ExtendedLocation
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, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.	DiskSku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
zones	The Logical zone list for Disk.	string[]

PurchasePlan

Name	Description	Value
name	The plan ID.	string (required)
product	Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.	string (required)
promotionCode	The Offer Promotion Code.	string
publisher	The publisher ID.	string (required)

ResourceTags

Name	Description	Value

SourceVault

Name	Description	Value
id	Resource Id	string

SupportedCapabilities

Name	Description	Value
acceleratedNetwork	True if the image from which the OS disk is created supports accelerated networking.	bool
architecture	CPU architecture supported by an OS disk.	'Arm64' 'x64'
diskControllerTypes	The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.	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": "2023-10-02",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "burstingEnabled": "bool",
    "completionPercent": "int",
    "creationData": {
      "createOption": "string",
      "elasticSanResourceId": "string",
      "galleryImageReference": {
        "communityGalleryImageId": "string",
        "id": "string",
        "lun": "int",
        "sharedGalleryImageId": "string"
      },
      "imageReference": {
        "communityGalleryImageId": "string",
        "id": "string",
        "lun": "int",
        "sharedGalleryImageId": "string"
      },
      "logicalSectorSize": "int",
      "performancePlus": "bool",
      "provisionedBandwidthCopySpeed": "string",
      "securityDataUri": "string",
      "sourceResourceId": "string",
      "sourceUri": "string",
      "storageAccountId": "string",
      "uploadSizeBytes": "int"
    },
    "dataAccessAuthMode": "string",
    "diskAccessId": "string",
    "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",
    "networkAccessPolicy": "string",
    "optimizedForFrequentAttach": "bool",
    "osType": "string",
    "publicNetworkAccess": "string",
    "purchasePlan": {
      "name": "string",
      "product": "string",
      "promotionCode": "string",
      "publisher": "string"
    },
    "securityProfile": {
      "secureVMDiskEncryptionSetId": "string",
      "securityType": "string"
    },
    "supportedCapabilities": {
      "acceleratedNetwork": "bool",
      "architecture": "string",
      "diskControllerTypes": "string"
    },
    "supportsHibernation": "bool",
    "tier": "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' 'CopyFromSanSnapshot' 'CopyStart' 'Empty' 'FromImage' 'Import' 'ImportSecure' 'Restore' 'Upload' 'UploadPreparedSecure' (required)
elasticSanResourceId	Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.	string
galleryImageReference	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.	ImageDiskReference
imageReference	Disk source information for PIR or user images.	ImageDiskReference
logicalSectorSize	Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.	int
performancePlus	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.	bool
provisionedBandwidthCopySpeed	If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.	'Enhanced' 'None'
securityDataUri	If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.	string
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
burstingEnabled	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.	bool
completionPercent	Percentage complete for the background copy when a resource is created via the CopyStart operation.	int
creationData	Disk source information. CreationData information cannot be changed after the disk has been created.	CreationData (required)
dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.	'AzureActiveDirectory' 'None'
diskAccessId	ARM id of the DiskAccess resource for using private endpoints on disks.	string
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
networkAccessPolicy	Policy for accessing the disk via network.	'AllowAll' 'AllowPrivate' 'DenyAll'
optimizedForFrequentAttach	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.	bool
osType	The Operating System type.	'Linux' 'Windows'
publicNetworkAccess	Policy for controlling export on the disk.	'Disabled' 'Enabled'
purchasePlan	Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}	PurchasePlan
securityProfile	Contains the security related information for the resource.	DiskSecurityProfile
supportedCapabilities	List of supported capabilities for the image from which the OS disk was created.	SupportedCapabilities
supportsHibernation	Indicates the OS on a disk supports hibernation.	bool
tier	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.	string

DiskSecurityProfile

Name	Description	Value
secureVMDiskEncryptionSetId	ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key	string
securityType	Specifies the SecurityType of the VM. Applicable for OS disks only.	'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_NonPersistedTPM' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch'

DiskSku

Name	Description	Value
name	The sku name.	'PremiumV2_LRS' 'Premium_LRS' 'Premium_ZRS' 'StandardSSD_LRS' 'StandardSSD_ZRS' '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' 'EncryptionAtRestWithPlatformAndCustomerKeys' '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

ExtendedLocation

Name	Description	Value
name	The name of the extended location.	string
type	The type of the extended location.	'EdgeZone'

ImageDiskReference

Name	Description	Value
communityGalleryImageId	A relative uri containing a community Azure Compute Gallery image reference.	string
id	A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.	string
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
sharedGalleryImageId	A relative uri containing a direct shared Azure Compute Gallery image reference.	string

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	'2023-10-02'
extendedLocation	The extended location where the disk will be created. Extended location cannot be changed.	ExtendedLocation
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, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_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[]

PurchasePlan

Name	Description	Value
name	The plan ID.	string (required)
product	Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.	string (required)
promotionCode	The Offer Promotion Code.	string
publisher	The publisher ID.	string (required)

ResourceTags

Name	Description	Value

SourceVault

Name	Description	Value
id	Resource Id	string

SupportedCapabilities

Name	Description	Value
acceleratedNetwork	True if the image from which the OS disk is created supports accelerated networking.	bool
architecture	CPU architecture supported by an OS disk.	'Arm64' 'x64'
diskControllerTypes	The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.	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@2023-10-02"
  name = "string"
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      burstingEnabled = bool
      completionPercent = int
      creationData = {
        createOption = "string"
        elasticSanResourceId = "string"
        galleryImageReference = {
          communityGalleryImageId = "string"
          id = "string"
          lun = int
          sharedGalleryImageId = "string"
        }
        imageReference = {
          communityGalleryImageId = "string"
          id = "string"
          lun = int
          sharedGalleryImageId = "string"
        }
        logicalSectorSize = int
        performancePlus = bool
        provisionedBandwidthCopySpeed = "string"
        securityDataUri = "string"
        sourceResourceId = "string"
        sourceUri = "string"
        storageAccountId = "string"
        uploadSizeBytes = int
      }
      dataAccessAuthMode = "string"
      diskAccessId = "string"
      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
      networkAccessPolicy = "string"
      optimizedForFrequentAttach = bool
      osType = "string"
      publicNetworkAccess = "string"
      purchasePlan = {
        name = "string"
        product = "string"
        promotionCode = "string"
        publisher = "string"
      }
      securityProfile = {
        secureVMDiskEncryptionSetId = "string"
        securityType = "string"
      }
      supportedCapabilities = {
        acceleratedNetwork = bool
        architecture = "string"
        diskControllerTypes = "string"
      }
      supportsHibernation = bool
      tier = "string"
    }
  })
}

Property values

CreationData

Name	Description	Value
createOption	This enumerates the possible sources of a disk's creation.	'Attach' 'Copy' 'CopyFromSanSnapshot' 'CopyStart' 'Empty' 'FromImage' 'Import' 'ImportSecure' 'Restore' 'Upload' 'UploadPreparedSecure' (required)
elasticSanResourceId	Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.	string
galleryImageReference	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.	ImageDiskReference
imageReference	Disk source information for PIR or user images.	ImageDiskReference
logicalSectorSize	Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.	int
performancePlus	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.	bool
provisionedBandwidthCopySpeed	If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.	'Enhanced' 'None'
securityDataUri	If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.	string
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
burstingEnabled	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.	bool
completionPercent	Percentage complete for the background copy when a resource is created via the CopyStart operation.	int
creationData	Disk source information. CreationData information cannot be changed after the disk has been created.	CreationData (required)
dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.	'AzureActiveDirectory' 'None'
diskAccessId	ARM id of the DiskAccess resource for using private endpoints on disks.	string
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
networkAccessPolicy	Policy for accessing the disk via network.	'AllowAll' 'AllowPrivate' 'DenyAll'
optimizedForFrequentAttach	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.	bool
osType	The Operating System type.	'Linux' 'Windows'
publicNetworkAccess	Policy for controlling export on the disk.	'Disabled' 'Enabled'
purchasePlan	Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}	PurchasePlan
securityProfile	Contains the security related information for the resource.	DiskSecurityProfile
supportedCapabilities	List of supported capabilities for the image from which the OS disk was created.	SupportedCapabilities
supportsHibernation	Indicates the OS on a disk supports hibernation.	bool
tier	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.	string

DiskSecurityProfile

Name	Description	Value
secureVMDiskEncryptionSetId	ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key	string
securityType	Specifies the SecurityType of the VM. Applicable for OS disks only.	'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_NonPersistedTPM' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' 'TrustedLaunch'

DiskSku

Name	Description	Value
name	The sku name.	'PremiumV2_LRS' 'Premium_LRS' 'Premium_ZRS' 'StandardSSD_LRS' 'StandardSSD_ZRS' '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' 'EncryptionAtRestWithPlatformAndCustomerKeys' '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

ExtendedLocation

Name	Description	Value
name	The name of the extended location.	string
type	The type of the extended location.	'EdgeZone'

ImageDiskReference

Name	Description	Value
communityGalleryImageId	A relative uri containing a community Azure Compute Gallery image reference.	string
id	A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.	string
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
sharedGalleryImageId	A relative uri containing a direct shared Azure Compute Gallery image reference.	string

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
extendedLocation	The extended location where the disk will be created. Extended location cannot be changed.	ExtendedLocation
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, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.	DiskSku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Compute/disks@2023-10-02"
zones	The Logical zone list for Disk.	string[]

PurchasePlan

Name	Description	Value
name	The plan ID.	string (required)
product	Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.	string (required)
promotionCode	The Offer Promotion Code.	string
publisher	The publisher ID.	string (required)

ResourceTags

Name	Description	Value

SourceVault

Name	Description	Value
id	Resource Id	string

SupportedCapabilities

Name	Description	Value
acceleratedNetwork	True if the image from which the OS disk is created supports accelerated networking.	bool
architecture	CPU architecture supported by an OS disk.	'Arm64' 'x64'
diskControllerTypes	The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.	string

Share via

Microsoft.Compute disks 2023-10-02

Bicep resource definition

Resource format

Property values

CreationData

DiskProperties

DiskSecurityProfile

DiskSku

Encryption

EncryptionSettingsCollection

EncryptionSettingsElement

ExtendedLocation

ImageDiskReference

KeyVaultAndKeyReference

KeyVaultAndSecretReference

Microsoft.Compute/disks

PurchasePlan

ResourceTags

SourceVault

SupportedCapabilities

Quickstart samples

ARM template resource definition

Resource format

Property values

CreationData

DiskProperties

DiskSecurityProfile

DiskSku

Encryption

EncryptionSettingsCollection

EncryptionSettingsElement

ExtendedLocation

ImageDiskReference

KeyVaultAndKeyReference

KeyVaultAndSecretReference

Microsoft.Compute/disks

PurchasePlan

ResourceTags

SourceVault

SupportedCapabilities

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

CreationData

DiskProperties

DiskSecurityProfile

DiskSku

Encryption

EncryptionSettingsCollection

EncryptionSettingsElement

ExtendedLocation

ImageDiskReference

KeyVaultAndKeyReference

KeyVaultAndSecretReference

Microsoft.Compute/disks

PurchasePlan

ResourceTags

SourceVault

SupportedCapabilities

Feedback

Additional resources