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

OSDiskArgs

data class OSDiskArgs(val caching: Output<CachingTypes>? = null, val createOption: Output<Either<String, DiskCreateOptionTypes>>, val deleteOption: Output<Either<String, DiskDeleteOptionTypes>>? = null, val diffDiskSettings: Output<DiffDiskSettingsArgs>? = null, val diskSizeGB: Output<Int>? = null, val encryptionSettings: Output<DiskEncryptionSettingsArgs>? = null, val image: Output<VirtualHardDiskArgs>? = null, val managedDisk: Output<ManagedDiskParametersArgs>? = null, val name: Output<String>? = null, val osType: Output<OperatingSystemTypes>? = null, val vhd: Output<VirtualHardDiskArgs>? = null, val writeAcceleratorEnabled: Output<Boolean>? = null) : ConvertibleToJava<OSDiskArgs>

Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see About disks and VHDs for Azure virtual machines.

Constructors

OSDiskArgs

fun OSDiskArgs(caching: Output<CachingTypes>? = null, createOption: Output<Either<String, DiskCreateOptionTypes>>, deleteOption: Output<Either<String, DiskDeleteOptionTypes>>? = null, diffDiskSettings: Output<DiffDiskSettingsArgs>? = null, diskSizeGB: Output<Int>? = null, encryptionSettings: Output<DiskEncryptionSettingsArgs>? = null, image: Output<VirtualHardDiskArgs>? = null, managedDisk: Output<ManagedDiskParametersArgs>? = null, name: Output<String>? = null, osType: Output<OperatingSystemTypes>? = null, vhd: Output<VirtualHardDiskArgs>? = null, writeAcceleratorEnabled: Output<Boolean>? = null)

Functions

toJava

open override fun toJava(): OSDiskArgs

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 OS Disk should be deleted or detached upon VM deletion.

Possible values:

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

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

The default value is set to detach. For an ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for ephemeral OS Disk.

diffDiskSettings

val diffDiskSettings: Output<DiffDiskSettingsArgs>? = null

Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

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

encryptionSettings

val encryptionSettings: Output<DiskEncryptionSettingsArgs>? = null

Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15

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.

managedDisk

val managedDisk: Output<ManagedDiskParametersArgs>? = null

The managed disk parameters.

name

val name: Output<String>? = null

The disk name.

osType

val osType: Output<OperatingSystemTypes>? = null

This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Possible values are:

Windows

Linux

vhd

val vhd: Output<VirtualHardDiskArgs>? = null

The virtual hard disk.

writeAcceleratorEnabled

val writeAcceleratorEnabled: Output<Boolean>? = null

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