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.v2019_07_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, os_type: str | _models.OperatingSystemTypes | None = None, hyper_v_generation: str | _models.HyperVGeneration | 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, encryption: _models.Encryption | 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, or UltraSSD_LRS.
zones
list[str]

The Logical zone list for Disk.
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".
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.
encryption
Encryption

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

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

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

The Logical zone list for Disk.
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".
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_state
str or DiskState

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

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