Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DataDisk

Package version

Describes a data disk.

Hierarchy

  • DataDisk

Index

Properties

Optional caching

caching: CachingTypes

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage

createOption

createOption: DiskCreateOptionTypes

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.

Optional deleteOption

deleteOption: DiskDeleteOptionTypes

Specifies whether data disk should be deleted or detached upon VM deletion.

Possible values:

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

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

The default value is set to detach

Optional detachOption

detachOption: DiskDetachOptionTypes

Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach.

detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.

This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.

Optional diskIopsReadWrite

diskIopsReadWrite: undefined | number

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.

Optional diskMBpsReadWrite

diskMBpsReadWrite: undefined | number

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.

Optional diskSizeGB

diskSizeGB: undefined | number

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

Optional 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

lun: number

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.

Optional managedDisk

The managed disk parameters.

Optional name

name: undefined | string

The disk name.

Optional toBeDetached

toBeDetached: undefined | false | true

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

Optional vhd

The virtual hard disk.

Optional writeAcceleratorEnabled

writeAcceleratorEnabled: undefined | false | true

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

Generated using TypeDoc