Share via

Disk Class

  • Reference

Disk resource.

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

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.compute.v2023_04_02.models._models_py3.Resource
Disk

Constructor

Disk(*, location: str, tags: Dict[str, str] | None = None, sku: _models.DiskSku | None = None, zones: List[str] | None = None, extended_location: _models.ExtendedLocation | None = None, os_type: str | _models.OperatingSystemTypes | None = None, hyper_v_generation: str | _models.HyperVGeneration | None = None, purchase_plan: _models.PurchasePlan | None = None, supported_capabilities: _models.SupportedCapabilities | None = None, creation_data: _models.CreationData | 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, encryption: _models.Encryption | None = None, max_shares: int | 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, supports_hibernation: bool | None = None, security_profile: _models.DiskSecurityProfile | None = None, completion_percent: float | 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
location
str

Resource location. Required.
tags
dict[str, str]

Resource tags.
sku
DiskSku

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
zones
list[str]

The Logical zone list for Disk.
extended_location
ExtendedLocation

The extended location where the disk will be created. Extended location cannot be changed.
os_type
str or OperatingSystemTypes

The Operating System type. Known values are: "Windows" and "Linux".
hyper_v_generation
str or HyperVGeneration

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

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
SupportedCapabilities

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

Disk source information. CreationData information cannot be changed after the disk has been created.
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
EncryptionSettingsCollection

Encryption settings collection used for 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.
encryption
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.
network_access_policy
str or 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.
supports_hibernation
bool

Indicates the OS on a disk supports hibernation.
security_profile
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
str or PublicNetworkAccess

Policy for controlling export on the disk. Known values are: "Enabled" and "Disabled".
data_access_auth_mode
str or 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.

Variables

Name Description
id
str

Resource Id.
name
str

Resource name.
type
str

Resource type.
location
str

Resource location. Required.
tags
dict[str, str]

Resource tags.
managed_by
str

A relative URI containing the ID of the VM that has the disk attached.
managed_by_extended
list[str]

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.
sku
DiskSku

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
zones
list[str]

The Logical zone list for Disk.
extended_location
ExtendedLocation

The extended location where the disk will be created. Extended location cannot be changed.
time_created
datetime

The time when the disk was created.
os_type
str or OperatingSystemTypes

The Operating System type. Known values are: "Windows" and "Linux".
hyper_v_generation
str or HyperVGeneration

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

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
SupportedCapabilities

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

Disk source information. CreationData information cannot be changed after the disk has been created.
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
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
str or DiskState

The state of the disk. Known values are: "Unattached", "Attached", "Reserved", "Frozen", "ActiveSAS", "ActiveSASFrozen", "ReadyToUpload", and "ActiveUpload".
encryption
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[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
str or 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
datetime

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
PropertyUpdatesInProgress

Properties of the disk for which update is pending.
supports_hibernation
bool

Indicates the OS on a disk supports hibernation.
security_profile
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
str or PublicNetworkAccess

Policy for controlling export on the disk. Known values are: "Enabled" and "Disabled".
data_access_auth_mode
str or 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
datetime

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.