DataDiskResponse

data class DataDiskResponse(val caching: String? = null, val createOption: String, val deleteOption: String? = null, val detachOption: String? = null, val diskIOPSReadWrite: Double, val diskMBpsReadWrite: Double, val diskSizeGB: Int? = null, val image: VirtualHardDiskResponse? = null, val lun: Int, val managedDisk: ManagedDiskParametersResponse? = null, val name: String? = null, val toBeDetached: Boolean? = null, val vhd: VirtualHardDiskResponse? = null, val writeAcceleratorEnabled: Boolean? = null)

Describes a data disk.

Constructors

Link copied to clipboard
constructor(caching: String? = null, createOption: String, deleteOption: String? = null, detachOption: String? = null, diskIOPSReadWrite: Double, diskMBpsReadWrite: Double, diskSizeGB: Int? = null, image: VirtualHardDiskResponse? = null, lun: Int, managedDisk: ManagedDiskParametersResponse? = null, name: String? = null, toBeDetached: Boolean? = null, vhd: VirtualHardDiskResponse? = null, writeAcceleratorEnabled: Boolean? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val caching: String? = null

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

Link copied to clipboard

Specifies how the virtual machine should be created. Possible values are: Attach. This value is used when you are using a specialized disk to create the virtual machine. FromImage. This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described.

Link copied to clipboard
val deleteOption: String? = null

Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: 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.

Link copied to clipboard
val detachOption: String? = null

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
val diskSizeGB: Int? = null

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.

Link copied to clipboard

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.

Link copied to clipboard
val 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.

Link copied to clipboard

The managed disk parameters.

Link copied to clipboard
val name: String? = null

The disk name.

Link copied to clipboard
val toBeDetached: Boolean? = null

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

Link copied to clipboard

The virtual hard disk.

Link copied to clipboard

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