DiskUpdate Class

Disk update resource.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.compute._serialization.Model
DiskUpdate

Constructor

DiskUpdate(*, tags: Dict[str, str] | None = None, sku: _models.DiskSku | None = None, os_type: str | _models.OperatingSystemTypes | None = None, disk_size_gb: int | None = None, encryption_settings_collection: _models.EncryptionSettingsCollection | None = None, disk_iops_read_write: int | None = None, disk_m_bps_read_write: int | None = None, disk_iops_read_only: int | None = None, disk_m_bps_read_only: int | None = None, max_shares: int | None = None, encryption: _models.Encryption | None = None, network_access_policy: str | _models.NetworkAccessPolicy | None = None, disk_access_id: str | None = None, tier: str | None = None, bursting_enabled: bool | None = None, purchase_plan: _models.PurchasePlan | None = None, supported_capabilities: _models.SupportedCapabilities | None = None, supports_hibernation: bool | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, data_access_auth_mode: str | _models.DataAccessAuthMode | None = None, optimized_for_frequent_attach: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
tags

Resource tags.

sku

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.

os_type

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

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

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

network_access_policy

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

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

Purchase plan information to be added on the OS disk.

supported_capabilities

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

supports_hibernation

Indicates the OS on a disk supports hibernation.

public_network_access

Policy for controlling export on the disk. Known values are: "Enabled" and "Disabled".

data_access_auth_mode

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

optimized_for_frequent_attach

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.

Variables

Name Description
tags

Resource tags.

sku

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.

os_type

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

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

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

network_access_policy

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

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

Purchase plan information to be added on the OS disk.

supported_capabilities

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

property_updates_in_progress

Properties of the disk for which update is pending.

supports_hibernation

Indicates the OS on a disk supports hibernation.

public_network_access

Policy for controlling export on the disk. Known values are: "Enabled" and "Disabled".

data_access_auth_mode

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

optimized_for_frequent_attach

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.