Managed Disk

This table represents the Managed Disk resource from Microsoft Azure.

azure.managed_disk

Fields

TitleIDTypeData TypeDescription
_keycorestring
bursting_enabledcoreboolSet to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.
bursting_enabled_timecorestringLatest time when bursting was last enabled on a disk.
completion_percentcorefloat64Percentage complete for the background copy when a resource is created via the CopyStart operation.
creation_datacorejsonDisk source information. CreationData information cannot be changed after the disk has been created.
data_access_auth_modecorestringAdditional authentication requirements when exporting or uploading to a disk or snapshot.
disk_access_idcorestringARM id of the DiskAccess resource for using private endpoints on disks.
disk_iops_read_onlycoreint64The 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_writecoreint64The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
disk_mbps_read_onlycoreint64The 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_writecoreint64The 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_bytescoreint64The size of the disk in bytes. This field is read only.
disk_statecorestringThe state of the disk.
encryptioncorejsonEncryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
encryption_settings_collectioncorejsonEncryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
extended_locationcorejsonThe extended location where the disk will be created. Extended location cannot be changed.
hyper_v_generationcorestringThe hypervisor generation of the Virtual Machine. Applicable to OS disks only.
idcorestringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
last_ownership_update_timecorestringThe UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started.
locationcorestringThe geo-location where the resource lives
managed_bycorestringA relative URI containing the ID of the VM that has the disk attached.
managed_by_extendedcorearray<string>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_sharescoreint64The 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.
namecorestringThe name of the resource
network_access_policycorestringPolicy for accessing the disk via network.
optimized_for_frequent_attachcoreboolSetting 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.
os_typecorestringThe Operating System type.
property_updates_in_progresscorejsonProperties of the disk for which update is pending.
provisioning_statecorestringThe disk provisioning state.
public_network_accesscorestringPolicy for controlling export on the disk.
purchase_plancorejsonPurchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}
resource_groupcorestring
security_profilecorejsonContains the security related information for the resource.
share_infocorejsonDetails 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.
skucorejsonThe disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
subscription_idcorestring
subscription_namecorestring
supported_capabilitiescorejsonList of supported capabilities for the image from which the OS disk was created.
supports_hibernationcoreboolIndicates the OS on a disk supports hibernation.
system_datacorejsonAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagscorehstore_csv
tiercorestringPerformance 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_createdcorestringThe time when the disk was created.
typecorestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
unique_idcorestringUnique Guid identifying the resource.
zonescorearray<string>The Logical zone list for Disk.