azure.mgmt.compute.types.DiskUpdateProperties class

Constructor

DiskUpdateProperties()

Variables

Name	Description
os_type	Union[str, <xref:"OperatingSystemTypes">] the Operating System type. Known values are: "Windows" and "Linux".
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.
encryption_settings_collection	<xref:<xref:"EncryptionSettingsCollection">> Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
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.
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.
encryption	<xref:<xref:"Encryption">> Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
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.
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.
purchase_plan	<xref:<xref:"DiskPurchasePlan">> Purchase plan information to be added on the OS disk.
supported_capabilities	<xref:<xref:"SupportedCapabilities">> List of supported capabilities to be added on the OS disk.
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.
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.
availability_policy	<xref:<xref:"AvailabilityPolicy">> Determines how platform treats disk failures.

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

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

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

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 be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

encryptionSettingsCollection: EncryptionSettingsCollection

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

publicNetworkAccess

"Enabled" and "Disabled".

publicNetworkAccess: str | PublicNetworkAccess

purchasePlan

Purchase plan information to be added on the OS disk.

purchasePlan: DiskPurchasePlan

supportedCapabilities

List of supported capabilities to be added on the OS disk.

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