DiskProperties Class

The 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.

LastOwnershipUpdateTime: str

Determines how platform treats disk failures.

availabilityPolicy: AvailabilityPolicy

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.

burstingEnabled: bool

Latest time when bursting was last enabled on a disk.

burstingEnabledTime: str

Percentage complete for the background copy when a resource is created via the CopyStart operation.

completionPercent: float

Disk source information. CreationData information cannot be changed after the disk has been created. Required.

creationData: Required[CreationData]

Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: "AzureActiveDirectory" and "None".

dataAccessAuthMode: str | DataAccessAuthMode

ARM id of the DiskAccess resource for using private endpoints on disks.

diskAccessId: str

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.

diskIOPSReadOnly: int

The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

diskIOPSReadWrite: int

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.

diskMBpsReadOnly: int

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.

diskMBpsReadWrite: int

The size of the disk in bytes. This field is read only.

diskSizeBytes: int

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.

diskSizeGB: int

"Unattached", "Attached", "Reserved", "Frozen", "ActiveSAS", "ActiveSASFrozen", "ReadyToUpload", and "ActiveUpload".

diskState: str | DiskState

Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.

encryption: Encryption

Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

encryptionSettingsCollection: EncryptionSettingsCollection

The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2".

hyperVGeneration: str | HyperVGeneration

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.

maxShares: int

"AllowAll", "AllowPrivate", and "DenyAll".

networkAccessPolicy: str | NetworkAccessPolicy

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.

optimizedForFrequentAttach: bool

"Windows" and "Linux".

osType: str | OperatingSystemTypes

Properties of the disk for which update is pending.

propertyUpdatesInProgress: PropertyUpdatesInProgress

The disk provisioning state.

provisioningState: str

"Enabled" and "Disabled".

publicNetworkAccess: str | PublicNetworkAccess

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

purchasePlan: DiskPurchasePlan

Contains the security related information for the resource.

securityProfile: DiskSecurityProfile

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.

shareInfo: list['ShareInfoElement']

List of supported capabilities for the image from which the OS disk was created.

supportedCapabilities: SupportedCapabilities

Indicates the OS on a disk supports hibernation.

supportsHibernation: bool

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.

tier: str

The time when the disk was created.

timeCreated: str

Unique Guid identifying the resource.

uniqueId: str