azure_managed_disk

bursting_enabled

Type: BOOLEAN
Provider name: properties.burstingEnabled
Description: 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.

creation_data

Type: STRUCT
Provider name: properties.creationData
Description: Disk source information. CreationData information cannot be changed after the disk has been created.

• create_option
  Type: STRING
  Provider name: createOption
  Description: This enumerates the possible sources of a disk’s creation.
  
• gallery_image_reference
  Type: STRUCT
  Provider name: galleryImageReference
  Description: 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.
  
  • id
    Type: STRING
    Provider name: id
    Description: A relative uri containing either a Platform Image Repository or user image reference.
    
  • lun
    Type: INT32
    Provider name: lun
    Description: 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.
    
• image_reference
  Type: STRUCT
  Provider name: imageReference
  Description: Disk source information.
  
  • id
    Type: STRING
    Provider name: id
    Description: A relative uri containing either a Platform Image Repository or user image reference.
    
  • lun
    Type: INT32
    Provider name: lun
    Description: 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.
    
• logical_sector_size
  Type: INT32
  Provider name: logicalSectorSize
  Description: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
  
• source_resource_id
  Type: STRING
  Provider name: sourceResourceId
  Description: If createOption is Copy, this is the ARM id of the source snapshot or disk.
  
• source_unique_id
  Type: STRING
  Provider name: sourceUniqueId
  Description: If this field is set, this is the unique id identifying the source of this resource.
  
• source_uri
  Type: STRING
  Provider name: sourceUri
  Description: If createOption is Import, this is the URI of a blob to be imported into a managed disk.
  
• storage_account_id
  Type: STRING
  Provider name: storageAccountId
  Description: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
  
• upload_size_bytes
  Type: INT64
  Provider name: uploadSizeBytes
  Description: 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).
  

disk_access_id

Type: STRING
Provider name: properties.diskAccessId
Description: ARM id of the DiskAccess resource for using private endpoints on disks.

disk_iops_read_only

Type: INT64
Provider name: properties.diskIOPSReadOnly
Description: 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.

disk_iops_read_write

Type: INT64
Provider name: properties.diskIOPSReadWrite
Description: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

disk_mbps_read_only

Type: INT64
Provider name: properties.diskMBpsReadOnly
Description: 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.

disk_mbps_read_write

Type: INT64
Provider name: properties.diskMBpsReadWrite
Description: 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.

disk_size_bytes

Type: INT64
Provider name: properties.diskSizeBytes
Description: The size of the disk in bytes. This field is read only.

disk_state

Type: STRING
Provider name: properties.diskState
Description: The state of the disk.

encryption

Type: STRUCT
Provider name: properties.encryption
Description: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.

• disk_encryption_set_id
  Type: STRING
  Provider name: diskEncryptionSetId
  Description: ResourceId of the disk encryption set to use for enabling encryption at rest.
  
• type
  Type: STRING
  Provider name: type
  

encryption_settings_collection

Type: STRUCT
Provider name: properties.encryptionSettingsCollection
Description: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

• enabled
  Type: BOOLEAN
  Provider name: enabled
  Description: 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.
  
• encryption_settings
  Type: UNORDERED_LIST_STRUCT
  Provider name: encryptionSettings
  Description: A collection of encryption settings, one for each disk volume.
  
  • disk_encryption_key
    Type: STRUCT
    Provider name: diskEncryptionKey
    Description: Key Vault Secret Url and vault id of the disk encryption key
    
    • secret_url
      Type: STRING
      Provider name: secretUrl
      Description: Url pointing to a key or secret in KeyVault
      
    • source_vault
      Type: STRUCT
      Provider name: sourceVault
      Description: Resource id of the KeyVault containing the key or secret
      
      • id
        Type: STRING
        Provider name: id
        Description: Resource Id
        
  • key_encryption_key
    Type: STRUCT
    Provider name: keyEncryptionKey
    Description: 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.
    
    • key_url
      Type: STRING
      Provider name: keyUrl
      Description: Url pointing to a key or secret in KeyVault
      
    • source_vault
      Type: STRUCT
      Provider name: sourceVault
      Description: Resource id of the KeyVault containing the key or secret
      
      • id
        Type: STRING
        Provider name: id
        Description: Resource Id
        
• encryption_settings_version
  Type: STRING
  Provider name: encryptionSettingsVersion
  Description: 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.
  

extended_location

Type: STRUCT
Provider name: extendedLocation
Description: The extended location where the disk will be created. Extended location cannot be changed.

• name
  Type: STRING
  Provider name: name
  Description: The name of the extended location.
  
• type
  Type: STRING
  Provider name: type
  Description: The type of the extended location.
  

hyper_v_generation

Type: STRING
Provider name: properties.hyperVGeneration
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

id

Type: STRING
Provider name: id
Description: Resource Id

location

Type: STRING
Provider name: location
Description: Resource location

managed_by

Type: STRING
Provider name: managedBy
Description: A relative URI containing the ID of the VM that has the disk attached.

managed_by_extended

Type: UNORDERED_LIST_STRING
Provider name: managedByExtended
Description: 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.

max_shares

Type: INT32
Provider name: properties.maxShares
Description: 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.

name

Type: STRING
Provider name: name
Description: Resource name

network_access_policy

Type: STRING
Provider name: properties.networkAccessPolicy

os_type

Type: STRING
Provider name: properties.osType
Description: The Operating System type.

property_updates_in_progress

Type: STRUCT
Provider name: properties.propertyUpdatesInProgress
Description: Properties of the disk for which update is pending.

• target_tier
  Type: STRING
  Provider name: targetTier
  Description: The target performance tier of the disk if a tier change operation is in progress.
  

provisioning_state

Type: STRING
Provider name: properties.provisioningState
Description: The disk provisioning state.

purchase_plan

Type: STRUCT
Provider name: properties.purchasePlan
Description: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

• name
  Type: STRING
  Provider name: name
  Description: The plan ID.
  
• product
  Type: STRING
  Provider name: product
  Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
  
• promotion_code
  Type: STRING
  Provider name: promotionCode
  Description: The Offer Promotion Code.
  
• publisher
  Type: STRING
  Provider name: publisher
  Description: The publisher ID.
  

resource_group

Type: STRING

security_profile

Type: STRUCT
Provider name: properties.securityProfile
Description: Contains the security related information for the resource.

• security_type
  Type: STRING
  Provider name: securityType
  

share_info

Type: UNORDERED_LIST_STRUCT
Provider name: properties.shareInfo
Description: 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.

• vm_uri
  Type: STRING
  Provider name: vmUri
  Description: A relative URI containing the ID of the VM that has the disk attached.
  

sku

Type: STRUCT
Provider name: sku

• name
  Type: STRING
  Provider name: name
  Description: The sku name.
  
• tier
  Type: STRING
  Provider name: tier
  Description: The sku tier.
  

subscription_id

Type: STRING

subscription_name

Type: STRING

supports_hibernation

Type: BOOLEAN
Provider name: properties.supportsHibernation
Description: Indicates the OS on a disk supports hibernation.

tags

Type: UNORDERED_LIST_STRING

tier

Type: STRING
Provider name: properties.tier
Description: 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.

time_created

Type: STRING
Provider name: properties.timeCreated
Description: The time when the disk was created.

type

Type: STRING
Provider name: type
Description: Resource type

unique_id

Type: STRING
Provider name: properties.uniqueId
Description: Unique Guid identifying the resource.

zones

Type: UNORDERED_LIST_STRING
Provider name: zones
Description: The Logical zone list for Disk.