pulumi-azure-native-kotlin/com.pulumi.azurenative.compute.kotlin.inputs/DataDiskArgs

DataDiskArgs

data class DataDiskArgs(val caching: Output<CachingTypes>? = null, val createOption: Output<Either<String, DiskCreateOptionTypes>>, val deleteOption: Output<Either<String, DiskDeleteOptionTypes>>? = null, val detachOption: Output<Either<String, DiskDetachOptionTypes>>? = null, val diskSizeGB: Output<Int>? = null, val image: Output<VirtualHardDiskArgs>? = null, val lun: Output<Int>, val managedDisk: Output<ManagedDiskParametersArgs>? = null, val name: Output<String>? = null, val toBeDetached: Output<Boolean>? = null, val vhd: Output<VirtualHardDiskArgs>? = null, val writeAcceleratorEnabled: Output<Boolean>? = null) : ConvertibleToJava<DataDiskArgs>

Describes a data disk.

Constructors

DataDiskArgs

constructor(caching: Output<CachingTypes>? = null, createOption: Output<Either<String, DiskCreateOptionTypes>>, deleteOption: Output<Either<String, DiskDeleteOptionTypes>>? = null, detachOption: Output<Either<String, DiskDetachOptionTypes>>? = null, diskSizeGB: Output<Int>? = null, image: Output<VirtualHardDiskArgs>? = null, lun: Output<Int>, managedDisk: Output<ManagedDiskParametersArgs>? = null, name: Output<String>? = null, toBeDetached: Output<Boolean>? = null, vhd: Output<VirtualHardDiskArgs>? = null, writeAcceleratorEnabled: Output<Boolean>? = null)

Properties

caching

val caching: Output<CachingTypes>? = null

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage

createOption

val createOption: Output<Either<String, 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.

deleteOption

val deleteOption: Output<Either<String, DiskDeleteOptionTypes>>? = null

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

detachOption

val detachOption: Output<Either<String, DiskDetachOptionTypes>>? = 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'.

diskSizeGB

val diskSizeGB: Output<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.

This value cannot be larger than 1023 GB

image

val image: Output<VirtualHardDiskArgs>? = null

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

val lun: Output<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.

managedDisk

val managedDisk: Output<ManagedDiskParametersArgs>? = null

The managed disk parameters.

name

val name: Output<String>? = null

The disk name.

toBeDetached

val toBeDetached: Output<Boolean>? = null

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

vhd

val vhd: Output<VirtualHardDiskArgs>? = null

The virtual hard disk.