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

Link copied to clipboard
constructor(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)

Properties

Link copied to clipboard
val caching: Output<CachingTypes>? = 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: Output<Either<String, DiskDeleteOptionTypes>>? = null

Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: 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. The user cannot change the delete option for an ephemeral OS Disk.

Link copied to clipboard

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

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

Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.

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

Link copied to clipboard

The managed disk parameters.

Link copied to clipboard
val name: Output<String>? = null

The disk name.

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

Link copied to clipboard
val vhd: Output<VirtualHardDiskArgs>? = null

The virtual hard disk.

Link copied to clipboard
val writeAcceleratorEnabled: Output<Boolean>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): OSDiskArgs