VirtualMachineOSDisk Class

Definition

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.

public class VirtualMachineOSDisk : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.Models.VirtualMachineOSDisk>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.Models.VirtualMachineOSDisk>
type VirtualMachineOSDisk = class
    interface IJsonModel<VirtualMachineOSDisk>
    interface IPersistableModel<VirtualMachineOSDisk>
Public Class VirtualMachineOSDisk
Implements IJsonModel(Of VirtualMachineOSDisk), IPersistableModel(Of VirtualMachineOSDisk)
Inheritance
VirtualMachineOSDisk
Implements

Constructors

VirtualMachineOSDisk(DiskCreateOptionType)

Initializes a new instance of VirtualMachineOSDisk.

Properties

Caching

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

CreateOption

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.

DeleteOption

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.

DiffDiskSettings

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

DiskSizeGB

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.

EncryptionSettings

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

ImageUri

Specifies the virtual hard disk's uri.

ManagedDisk

The managed disk parameters.

Name

The disk name.

OSType

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..

VhdUri

Specifies the virtual hard disk's uri.

WriteAcceleratorEnabled

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

Explicit Interface Implementations

IJsonModel<VirtualMachineOSDisk>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<VirtualMachineOSDisk>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<VirtualMachineOSDisk>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<VirtualMachineOSDisk>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<VirtualMachineOSDisk>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to