Share via


VirtualMachineScaleSetOSDisk Class

Definition

Describes a virtual machine scale set operating system disk.

public class VirtualMachineScaleSetOSDisk
type VirtualMachineScaleSetOSDisk = class
Public Class VirtualMachineScaleSetOSDisk
Inheritance
VirtualMachineScaleSetOSDisk

Constructors

VirtualMachineScaleSetOSDisk()

Initializes a new instance of the VirtualMachineScaleSetOSDisk class.

VirtualMachineScaleSetOSDisk(String, String, Nullable<CachingTypes>, Nullable<Boolean>, DiffDiskSettings, Nullable<Int32>, Nullable<OperatingSystemTypes>, VirtualHardDisk, IList<String>, VirtualMachineScaleSetManagedDiskParameters, String)

Initializes a new instance of the VirtualMachineScaleSetOSDisk class.

Properties

Caching

Gets or sets specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

CreateOption

Gets or sets 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. Possible values include: 'FromImage', 'Empty', 'Attach'

DeleteOption

Gets or sets specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). &lt;br&gt;&lt;br&gt; Possible values: &lt;br&gt;&lt;br&gt; Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.&lt;br&gt;&lt;br&gt; Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. &lt;br&gt;&lt;br&gt; 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. Possible values include: 'Delete', 'Detach'

DiffDiskSettings

Gets or sets specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.

DiskSizeGB

Gets or sets 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.

Image

Gets or sets specifies information about the unmanaged user image to base the scale set on.

ManagedDisk

Gets or sets the managed disk parameters.

Name

Gets or sets the disk name.

OsType

Gets or sets 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.. Possible values include: 'Windows', 'Linux'

VhdContainers

Gets or sets specifies the container urls that are used to store operating system disks for the scale set.

WriteAcceleratorEnabled

Gets or sets specifies whether writeAccelerator should be enabled or disabled on the disk.

Methods

Validate()

Validate the object.

Applies to