VirtualMachineScaleSetOSDiskArgs

data class VirtualMachineScaleSetOSDiskArgs(val caching: Output<Either<String, 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 image: Output<VirtualHardDiskArgs>? = null, val managedDisk: Output<VirtualMachineScaleSetManagedDiskParametersArgs>? = null, val name: Output<String>? = null, val osType: Output<Either<String, OperatingSystemTypes>>? = null, val vhdContainers: Output<List<String>>? = null, val writeAcceleratorEnabled: Output<Boolean>? = null) : ConvertibleToJava<VirtualMachineScaleSetOSDiskArgs>

Describes a virtual machine scale set operating system disk.

Constructors

Link copied to clipboard
constructor(caching: Output<Either<String, CachingTypes>>? = null, createOption: Output<Either<String, DiskCreateOptionTypes>>, deleteOption: Output<Either<String, DiskDeleteOptionTypes>>? = null, diffDiskSettings: Output<DiffDiskSettingsArgs>? = null, diskSizeGB: Output<Int>? = null, image: Output<VirtualHardDiskArgs>? = null, managedDisk: Output<VirtualMachineScaleSetManagedDiskParametersArgs>? = null, name: Output<String>? = null, osType: Output<Either<String, OperatingSystemTypes>>? = null, vhdContainers: Output<List<String>>? = null, writeAcceleratorEnabled: Output<Boolean>? = null)

Properties

Link copied to clipboard
val caching: Output<Either<String, CachingTypes>>? = null

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

Link copied to clipboard

Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage. 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.

Link copied to clipboard
val deleteOption: Output<Either<String, DiskDeleteOptionTypes>>? = null

Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

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

Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

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

Link copied to clipboard

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

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
val image: Output<VirtualHardDiskArgs>? = null

Specifies information about the unmanaged user image to base the scale set on.

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<Either<String, 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 vhdContainers: Output<List<String>>? = null

Specifies the container urls that are used to store operating system disks for the scale set.

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(): VirtualMachineScaleSetOSDiskArgs