VirtualMachineScaleSetDataDisk Class

Describes a virtual machine scale set data disk.

Constructor

VirtualMachineScaleSetDataDisk()

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	Union[str, <xref:"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	Union[str, <xref:"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.
storage_fault_domain_alignment	Union[str, <xref:"StorageFaultDomainAlignmentType">] Specifies the storage fault domain alignment type for the disk. Known values are: "Aligned" and "BestEffortAligned".
managed_disk	<xref:<xref:"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	Union[str, <xref:"DiskDeleteOptionTypes">] Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted. Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted. The default value is set to Delete. Known values are: "Delete" and "Detach".

Attributes

caching

None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: "None", "ReadOnly", and "ReadWrite".

caching: str | CachingTypes

createOption

"FromImage", "Empty", "Attach", "Copy", and "Restore".

createOption: Required[str | DiskCreateOptionTypes]

deleteOption

Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to Delete. Known values are: "Delete" and "Detach".

deleteOption: str | DiskDeleteOptionTypes

diskIOPSReadWrite

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.

diskIOPSReadWrite: int

diskMBpsReadWrite

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.

diskMBpsReadWrite: int

diskSizeGB

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.

diskSizeGB: int

lun

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.

lun: Required[int]

managedDisk

The managed disk parameters.

managedDisk: VirtualMachineScaleSetManagedDiskParameters

name

The disk name.

name: str

storageFaultDomainAlignment

"Aligned" and "BestEffortAligned".

storageFaultDomainAlignment: str | StorageFaultDomainAlignmentType

writeAcceleratorEnabled

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

writeAcceleratorEnabled: bool