DataDisk Class

Describes a data disk.

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

Inheritance

Model

DataDisk

Constructor

DataDisk(*, lun: int, create_option: Union[str, azure.mgmt.compute.v2021_04_01.models._compute_management_client_enums.DiskCreateOptionTypes], name: Optional[str] = None, vhd: Optional[azure.mgmt.compute.v2021_04_01.models._models_py3.VirtualHardDisk] = None, image: Optional[azure.mgmt.compute.v2021_04_01.models._models_py3.VirtualHardDisk] = None, caching: Optional[Union[str, azure.mgmt.compute.v2021_04_01.models._compute_management_client_enums.CachingTypes]] = None, write_accelerator_enabled: Optional[bool] = None, disk_size_gb: Optional[int] = None, managed_disk: Optional[azure.mgmt.compute.v2021_04_01.models._models_py3.ManagedDiskParameters] = None, to_be_detached: Optional[bool] = None, detach_option: Optional[Union[str, azure.mgmt.compute.v2021_04_01.models._compute_management_client_enums.DiskDetachOptionTypes]] = None, delete_option: Optional[Union[str, azure.mgmt.compute.v2021_04_01.models._compute_management_client_enums.DiskDeleteOptionTypes]] = None, **kwargs)

Parameters

lun

int

Required

Required. Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

name

str

Required

The disk name.

vhd

VirtualHardDisk

Required

The virtual hard disk.

image

VirtualHardDisk

Required

The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.

caching

str or CachingTypes

Required

Specifies the caching requirements. <br>``<br> Possible values are: <br>``<br> None <br>``<br> ReadOnly <br>``<br> ReadWrite <br>``<br> Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: "None", "ReadOnly", "ReadWrite".

write_accelerator_enabled

bool

Required

Specifies whether writeAccelerator should be enabled or disabled on the disk.

create_option

str or DiskCreateOptionTypes

Required

Required. Specifies how the virtual machine should be created.:code:
<br> Possible values are:<br>``<br> Attach – This value is used when you are using a specialized disk to create the virtual machine.:code:
<br> FromImage – This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: "FromImage", "Empty", "Attach".

disk_size_gb

int

Required

Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br>``<br> This value cannot be larger than 1023 GB.

managed_disk

ManagedDiskParameters

Required

The managed disk parameters.

to_be_detached

bool

Required

Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset.

detach_option

str or DiskDetachOptionTypes

Required

Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. <br>``<br> detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. <br>``<br> This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. Possible values include: "ForceDetach".

delete_option

str or DiskDeleteOptionTypes

Required

Specifies whether data disk should be deleted or detached upon VM deletion.:code:
<br> Possible values: <br>``<br> Delete If this value is used, the data disk is deleted when VM is deleted.:code:
<br> Detach If this value is used, the data disk is retained after VM is deleted.:code:
<br> The default value is set to detach. Possible values include: "Delete", "Detach".

Variables

disk_iops_read_write

<xref:long>

Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.

disk_m_bps_read_write

<xref:long>

Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.