Share via

VirtualMachineScaleSetDataDisk Class

  • Reference

Describes a virtual machine scale set data disk.

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

Inheritance
azure.mgmt.compute._serialization.Model
VirtualMachineScaleSetDataDisk

Constructor

VirtualMachineScaleSetDataDisk(*, lun: int, create_option: str | _models.DiskCreateOptionTypes, name: str | None = None, caching: str | _models.CachingTypes | None = None, write_accelerator_enabled: bool | None = None, disk_size_gb: int | None = None, managed_disk: _models.VirtualMachineScaleSetManagedDiskParameters | None = None, disk_iops_read_write: int | None = None, disk_m_bps_read_write: int | None = None, delete_option: str | _models.DiskDeleteOptionTypes | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
name
str

The disk name.
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.
caching
str or CachingTypes

Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: 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

The create option. Required. Known values are: "FromImage", "Empty", "Attach", "Copy", and "Restore".
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. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
managed_disk
VirtualMachineScaleSetManagedDiskParameters

The managed disk parameters.
disk_iops_read_write
int

Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.
disk_m_bps_read_write
int

Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.
delete_option
str or DiskDeleteOptionTypes

Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).:code:
<br> Possible values: <br>``<br> Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.:code:
<br> Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted.:code:
<br> The default value is set to Delete. Known values are: "Delete" and "Detach".

Variables

Name Description
name
str

The disk name.
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.
caching
str or CachingTypes

Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: 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

The create option. Required. Known values are: "FromImage", "Empty", "Attach", "Copy", and "Restore".
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. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
managed_disk
VirtualMachineScaleSetManagedDiskParameters

The managed disk parameters.
disk_iops_read_write
int

Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.
disk_m_bps_read_write
int

Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.
delete_option
str or DiskDeleteOptionTypes

Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).:code:
<br> Possible values: <br>``<br> Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.:code:
<br> Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted.:code:
<br> The default value is set to Delete. Known values are: "Delete" and "Detach".