OSDisk 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 OSDisk
type OSDisk = class
Public Class OSDisk
Inheritance
OSDisk

Constructors

OSDisk()

Initializes a new instance of the OSDisk class.

OSDisk(String, Nullable<OperatingSystemTypes>, DiskEncryptionSettings, String, VirtualHardDisk, VirtualHardDisk, Nullable<CachingTypes>, Nullable<Boolean>, DiffDiskSettings, Nullable<Int32>, ManagedDiskParameters, String)

Initializes a new instance of the OSDisk class.

Properties

Caching

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

CreateOption

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

DeleteOption

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

DiffDiskSettings

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

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.

EncryptionSettings

Gets or sets specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.

Image

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

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'

Vhd

Gets or sets the virtual hard disk.

WriteAcceleratorEnabled

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

Methods

Validate()

Validate the object.

Applies to