Share via

DataDisk interface

  • Reference
Package:
@azure/arm-compute-profile-2020-09-01-hybrid

Describes a data disk.

Properties

caching

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage
createOption

Specifies how the virtual machine should be created.

Possible values are:

Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.

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

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. NOTE: This property will not be serialized. It can only be populated by the server.
diskMBpsReadWrite

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. NOTE: This property will not be serialized. It can only be populated by the server.
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.

This value cannot be larger than 1023 GB
image

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

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

The virtual hard disk.
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

Default: None for Standard storage. ReadOnly for Premium storage

caching?: CachingTypes

Property Value

CachingTypes

createOption

Specifies how the virtual machine should be created.

Possible values are:

Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.

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.

createOption: string

Property Value

string

diskIopsReadWrite

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. NOTE: This property will not be serialized. It can only be populated by the server.

diskIopsReadWrite?: number

Property Value

number

diskMBpsReadWrite

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. NOTE: This property will not be serialized. It can only be populated by the server.

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.

This value cannot be larger than 1023 GB

diskSizeGB?: number

Property Value

number

image

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.

image?: VirtualHardDisk

Property Value

VirtualHardDisk

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

Property Value

ManagedDiskParameters

name

The disk name.

name?: string

Property Value

string

toBeDetached

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

toBeDetached?: boolean

Property Value

boolean

vhd

The virtual hard disk.

vhd?: VirtualHardDisk

Property Value

VirtualHardDisk

writeAcceleratorEnabled

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

writeAcceleratorEnabled?: boolean

Property Value

boolean