azure.mgmt.compute.types.DiskProperties class

Constructor

DiskProperties()

Variables

Name	Description
time_created	str The time when the disk was created.
os_type	Union[str, <xref:"OperatingSystemTypes">] The Operating System type. Known values are: "Windows" and "Linux".
hyper_v_generation	Union[str, <xref:"HyperVGeneration">] The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2".
purchase_plan	<xref:<xref:"DiskPurchasePlan">> Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}.
supported_capabilities	<xref:<xref:"SupportedCapabilities">> List of supported capabilities for the image from which the OS disk was created.
creation_data	<xref:<xref:"CreationData">> Disk source information. CreationData information cannot be changed after the disk has been created. Required.
disk_size_gb	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.
disk_size_bytes	int The size of the disk in bytes. This field is read only.
unique_id	str Unique Guid identifying the resource.
encryption_settings_collection	<xref:<xref:"EncryptionSettingsCollection">> Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
provisioning_state	str The disk provisioning state.
disk_iops_read_write	int The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
disk_m_bps_read_write	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.
disk_iops_read_only	int 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_m_bps_read_only	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.
disk_state	Union[str, <xref:"DiskState">] The state of the disk. Known values are: "Unattached", "Attached", "Reserved", "Frozen", "ActiveSAS", "ActiveSASFrozen", "ReadyToUpload", and "ActiveUpload".
encryption	<xref:<xref:"Encryption">> Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
max_shares	int 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.
share_info	list[<xref:"ShareInfoElement">] 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.
network_access_policy	Union[str, <xref:"NetworkAccessPolicy">] Policy for accessing the disk via network. Known values are: "AllowAll", "AllowPrivate", and "DenyAll".
disk_access_id	str ARM id of the DiskAccess resource for using private endpoints on disks.
bursting_enabled_time	str Latest time when bursting was last enabled on a disk.
tier	str 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.
bursting_enabled	bool 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.
property_updates_in_progress	<xref:<xref:"PropertyUpdatesInProgress">> Properties of the disk for which update is pending.
supports_hibernation	bool Indicates the OS on a disk supports hibernation.
security_profile	<xref:<xref:"DiskSecurityProfile">> Contains the security related information for the resource.
completion_percent	float Percentage complete for the background copy when a resource is created via the CopyStart operation.
public_network_access	Union[str, <xref:"PublicNetworkAccess">] Policy for controlling export on the disk. Known values are: "Enabled" and "Disabled".
data_access_auth_mode	Union[str, <xref:"DataAccessAuthMode">] Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: "AzureActiveDirectory" and "None".
optimized_for_frequent_attach	bool 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.
last_ownership_update_time	str 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.
availability_policy	<xref:<xref:"AvailabilityPolicy">> Determines how platform treats disk failures.

LastOwnershipUpdateTime

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

availabilityPolicy

Determines how platform treats disk failures.

availabilityPolicy: AvailabilityPolicy

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.

burstingEnabled: bool

burstingEnabledTime

Latest time when bursting was last enabled on a disk.

burstingEnabledTime: str

completionPercent

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

completionPercent: float

creationData

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

creationData: Required[CreationData]

dataAccessAuthMode

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

dataAccessAuthMode: str | DataAccessAuthMode

diskAccessId

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

diskAccessId: str

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.

diskIOPSReadOnly: int

diskIOPSReadWrite

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

diskIOPSReadWrite: 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.

diskMBpsReadOnly: 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.

diskMBpsReadWrite: int

diskSizeBytes

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

diskSizeBytes: 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.

diskSizeGB: int

diskState

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

diskState: str | DiskState

encryption

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

encryption: Encryption

encryptionSettingsCollection

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

encryptionSettingsCollection: EncryptionSettingsCollection

hyperVGeneration

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

hyperVGeneration: str | HyperVGeneration

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.

maxShares: int

networkAccessPolicy

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

networkAccessPolicy: str | NetworkAccessPolicy

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.

optimizedForFrequentAttach: bool

osType

"Windows" and "Linux".

osType: str | OperatingSystemTypes

propertyUpdatesInProgress

Properties of the disk for which update is pending.

propertyUpdatesInProgress: PropertyUpdatesInProgress

provisioningState

The disk provisioning state.

provisioningState: str

publicNetworkAccess

"Enabled" and "Disabled".

publicNetworkAccess: str | PublicNetworkAccess

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: DiskPurchasePlan

securityProfile

Contains the security related information for the resource.

securityProfile: DiskSecurityProfile

shareInfo

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']

supportedCapabilities

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

supportedCapabilities: SupportedCapabilities

supportsHibernation

Indicates the OS on a disk supports hibernation.

supportsHibernation: 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.

tier: str

timeCreated

The time when the disk was created.

timeCreated: str

uniqueId

Unique Guid identifying the resource.

uniqueId: str