Share via

Microsoft.Compute disks 2017-03-30

  • Article

Bicep resource definition

The disks resource type can be deployed with operations that target:

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@2017-03-30' = {
  location: 'string'
  name: 'string'
  properties: {
    creationData: {
      createOption: 'string'
      imageReference: {
        id: 'string'
        lun: int
      }
      sourceResourceId: 'string'
      sourceUri: 'string'
      storageAccountId: 'string'
    }
    diskSizeGB: int
    encryptionSettings: {
      diskEncryptionKey: {
        secretUrl: 'string'
        sourceVault: {
          id: 'string'
        }
      }
      enabled: bool
      keyEncryptionKey: {
        keyUrl: 'string'
        sourceVault: {
          id: 'string'
        }
      }
    }
    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' (required)
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 If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription string

DiskProperties

Name Description Value
creationData Disk source information. CreationData information cannot be changed after the disk has been created. CreationData (required)
diskSizeGB If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD 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
encryptionSettings Encryption settings for disk or snapshot EncryptionSettings
osType The Operating System type. 'Linux'
'Windows'

DiskSku

Name Description Value
name The sku name. 'Premium_LRS'
'Standard_LRS'

EncryptionSettings

Name Description Value
diskEncryptionKey Key Vault Secret Url and vault id of the disk encryption key KeyVaultAndSecretReference
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
keyEncryptionKey Key Vault Key Url and vault id of the key 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 and snapshots sku name. Can be Standard_LRS or Premium_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:

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": "2017-03-30",
  "name": "string",
  "location": "string",
  "properties": {
    "creationData": {
      "createOption": "string",
      "imageReference": {
        "id": "string",
        "lun": "int"
      },
      "sourceResourceId": "string",
      "sourceUri": "string",
      "storageAccountId": "string"
    },
    "diskSizeGB": "int",
    "encryptionSettings": {
      "diskEncryptionKey": {
        "secretUrl": "string",
        "sourceVault": {
          "id": "string"
        }
      },
      "enabled": "bool",
      "keyEncryptionKey": {
        "keyUrl": "string",
        "sourceVault": {
          "id": "string"
        }
      }
    },
    "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' (required)
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 If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription string

DiskProperties

Name Description Value
creationData Disk source information. CreationData information cannot be changed after the disk has been created. CreationData (required)
diskSizeGB If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD 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
encryptionSettings Encryption settings for disk or snapshot EncryptionSettings
osType The Operating System type. 'Linux'
'Windows'

DiskSku

Name Description Value
name The sku name. 'Premium_LRS'
'Standard_LRS'

EncryptionSettings

Name Description Value
diskEncryptionKey Key Vault Secret Url and vault id of the disk encryption key KeyVaultAndSecretReference
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
keyEncryptionKey Key Vault Key Url and vault id of the key 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 '2017-03-30'
location Resource location string (required)
name The resource name string (required)
properties Disk resource properties. DiskProperties
sku The disks and snapshots sku name. Can be Standard_LRS or Premium_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

Deploy to Azure		 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

Deploy to Azure		 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

Deploy to Azure		 Template that creates a disk and enables protection via Backup Vault
Create VM from existing VHDs and connect it to existingVNET

Deploy to Azure		 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

Deploy to Azure		 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

Deploy to Azure		 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

Deploy to Azure		 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

Deploy to Azure		 Windows Docker Host with Portainer and Traefik pre-installed
Windows Server VM with SSH

Deploy to Azure		 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@2017-03-30"
  name = "string"
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
  body = jsonencode({
    properties = {
      creationData = {
        createOption = "string"
        imageReference = {
          id = "string"
          lun = int
        }
        sourceResourceId = "string"
        sourceUri = "string"
        storageAccountId = "string"
      }
      diskSizeGB = int
      encryptionSettings = {
        diskEncryptionKey = {
          secretUrl = "string"
          sourceVault = {
            id = "string"
          }
        }
        enabled = bool
        keyEncryptionKey = {
          keyUrl = "string"
          sourceVault = {
            id = "string"
          }
        }
      }
      osType = "string"
    }
  })
}

Property values

CreationData

Name Description Value
createOption This enumerates the possible sources of a disk's creation. 'Attach'
'Copy'
'Empty'
'FromImage'
'Import' (required)
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 If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription string

DiskProperties

Name Description Value
creationData Disk source information. CreationData information cannot be changed after the disk has been created. CreationData (required)
diskSizeGB If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD 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
encryptionSettings Encryption settings for disk or snapshot EncryptionSettings
osType The Operating System type. 'Linux'
'Windows'

DiskSku

Name Description Value
name The sku name. 'Premium_LRS'
'Standard_LRS'

EncryptionSettings

Name Description Value
diskEncryptionKey Key Vault Secret Url and vault id of the disk encryption key KeyVaultAndSecretReference
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
keyEncryptionKey Key Vault Key Url and vault id of the key 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 and snapshots sku name. Can be Standard_LRS or Premium_LRS. DiskSku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Compute/disks@2017-03-30"
zones The Logical zone list for Disk. string[]

ResourceTags

Name Description Value

SourceVault

Name Description Value
id Resource Id string