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

Inheritance

azure.mgmt.compute._serialization.Model

DataDisk

Constructor

DataDisk(*, lun: int, create_option: str | _models.DiskCreateOptionTypes, name: str | None = None, vhd: _models.VirtualHardDisk | None = None, image: _models.VirtualHardDisk | None = None, caching: str | _models.CachingTypes | None = None, write_accelerator_enabled: bool | None = None, disk_size_gb: int | None = None, managed_disk: _models.ManagedDiskParameters | None = None, to_be_detached: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
lun	int 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. Required.
name	str The disk name.
vhd	VirtualHardDisk The virtual hard disk.
image	VirtualHardDisk 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 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. Known values are: "None", "ReadOnly", and "ReadWrite".
write_accelerator_enabled	bool Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option	str or DiskCreateOptionTypes Specifies how the virtual machine should be created.:code: <br> Possible values are:<br>``<br> Attach u2013 This value is used when you are using a specialized disk to create the virtual machine.:code: <br> FromImage u2013 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. Required. Known values are: "FromImage", "Empty", and "Attach".
disk_size_gb	int 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 The managed disk parameters.
to_be_detached	bool Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset.

Variables

Name	Description
lun	int 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. Required.
name	str The disk name.
vhd	VirtualHardDisk The virtual hard disk.
image	VirtualHardDisk 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 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. Known values are: "None", "ReadOnly", and "ReadWrite".
write_accelerator_enabled	bool Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option	str or DiskCreateOptionTypes Specifies how the virtual machine should be created.:code: <br> Possible values are:<br>``<br> Attach u2013 This value is used when you are using a specialized disk to create the virtual machine.:code: <br> FromImage u2013 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. Required. Known values are: "FromImage", "Empty", and "Attach".
disk_size_gb	int 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 The managed disk parameters.
to_be_detached	bool Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset.
disk_iops_read_write	int 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	int 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.