Disk Class

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.v2021_12_01.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, **kwargs: Any)

Keyword-Only Parameters

Name Description
location
str

Resource location. Required.

tags

Resource tags.

sku

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

zones

The Logical zone list for Disk.

extended_location

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

os_type

The Operating System type. Known values are: "Windows" and "Linux".

hyper_v_generation

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

purchase_plan

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

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

creation_data

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

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

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.

supports_hibernation

Indicates the OS on a disk supports hibernation.

security_profile

Contains the security related information for the resource.

completion_percent

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

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

Variables

Name Description
id
str

Resource Id.

name
str

Resource name.

type
str

Resource type.

location
str

Resource location. Required.

tags

Resource tags.

managed_by
str

A relative URI containing the ID of the VM that has the disk attached.

managed_by_extended

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

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

zones

The Logical zone list for Disk.

extended_location

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

time_created

The time when the disk was created.

os_type

The Operating System type. Known values are: "Windows" and "Linux".

hyper_v_generation

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

purchase_plan

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

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

creation_data

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

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

The state of the disk. Known values are: "Unattached", "Attached", "Reserved", "Frozen", "ActiveSAS", "ActiveSASFrozen", "ReadyToUpload", and "ActiveUpload".

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

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

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.

property_updates_in_progress

Properties of the disk for which update is pending.

supports_hibernation

Indicates the OS on a disk supports hibernation.

security_profile

Contains the security related information for the resource.

completion_percent

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

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