OSDisk Class

Definition

Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see About disks and VHDs for Azure virtual machines.

public class OSDisk
type OSDisk = class
Public Class OSDisk
Inheritance
System.Object
OSDisk

Constructors

OSDisk()

Initializes a new instance of the OSDisk class.

Properties

Caching

Gets or sets specifies the caching requirements. &lt;br&gt;&lt;br&gt; Possible values are: &lt;br&gt;&lt;br&gt; None &lt;br&gt;&lt;br&gt; ReadOnly &lt;br&gt;&lt;br&gt; ReadWrite &lt;br&gt;&lt;br&gt; Default: 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.&lt;br&gt;&lt;br&gt; Possible values are:&lt;br&gt;&lt;br&gt; Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.&lt;br&gt;&lt;br&gt; FromImage \u2013 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'

DiskSizeGB

Gets or sets specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. &lt;br&gt;&lt;br&gt; This value cannot be larger than 1023 GB

EncryptionSettings

Gets or sets specifies the encryption settings for the OS Disk. &lt;br&gt;&lt;br&gt; 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. &lt;br&gt;&lt;br&gt; Possible values are: &lt;br&gt;&lt;br&gt; Windows &lt;br&gt;&lt;br&gt; Linux. Possible values include: 'Windows', 'Linux'

Vhd

Gets or sets the virtual hard disk.

Methods

Validate()

Validate the object.

Applies to