VirtualMachineScaleSetDataDisk interface

Describes a virtual machine scale set data disk.

Properties

caching

Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.

createOption

The create option.

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.

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.

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.

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.

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.

managedDisk

The managed disk parameters.

name

The disk name.

writeAcceleratorEnabled

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

Property Details

caching

Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.

caching?: CachingTypes

Property Value

createOption

The create option.

createOption: string

Property Value

string

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.

deleteOption?: string

Property Value

string

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?: number

Property Value

number

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?: number

Property Value

number

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?: number

Property Value

number

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.

lun: number

Property Value

number

managedDisk

The managed disk parameters.

managedDisk?: VirtualMachineScaleSetManagedDiskParameters

Property Value

name

The disk name.

name?: string

Property Value

string

writeAcceleratorEnabled

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

writeAcceleratorEnabled?: boolean

Property Value

boolean