Class OSDisk

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.

Inheritance

Object

OSDisk

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.Management.Compute.dll

Syntax

public class OSDisk

Constructors

OSDisk()

Initializes a new instance of the OSDisk class.

Declaration

public OSDisk ();

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

Initializes a new instance of the OSDisk class.

Declaration

public OSDisk (string createOption, Nullable<Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes> osType = null, Microsoft.Azure.Management.Compute.Models.DiskEncryptionSettings encryptionSettings = null, string name = null, Microsoft.Azure.Management.Compute.Models.VirtualHardDisk vhd = null, Microsoft.Azure.Management.Compute.Models.VirtualHardDisk image = null, Nullable<Microsoft.Azure.Management.Compute.Models.CachingTypes> caching = null, Nullable<bool> writeAcceleratorEnabled = null, Microsoft.Azure.Management.Compute.Models.DiffDiskSettings diffDiskSettings = null, Nullable<int> diskSizeGB = null, Microsoft.Azure.Management.Compute.Models.ManagedDiskParameters managedDisk = null);

Parameters

String createOption Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> 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'

Nullable<OperatingSystemTypes> 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. <br><br> Possible values are: <br><br> Windows <br><br> Linux. Possible values include: 'Windows', 'Linux'

DiskEncryptionSettings encryptionSettings Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15

String name The disk name.

VirtualHardDisk vhd The virtual hard disk.

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

Nullable<CachingTypes> caching Specifies the caching requirements. <br><br> Possible values are: <br><br> None <br><br> ReadOnly <br><br> ReadWrite <br><br> Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

Nullable<Boolean> writeAcceleratorEnabled Specifies whether writeAccelerator should be enabled or disabled on the disk.

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

Nullable<Int32> 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. <br><br> This value cannot be larger than 1023 GB

ManagedDiskParameters managedDisk The managed disk parameters.

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'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="caching")]
public Nullable<Microsoft.Azure.Management.Compute.Models.CachingTypes> Caching { get; set; }

Property Value

Nullable<CachingTypes>

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'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="createOption")]
public string CreateOption { get; set; }

Property Value

String

DiffDiskSettings

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="diffDiskSettings")]
public Microsoft.Azure.Management.Compute.Models.DiffDiskSettings DiffDiskSettings { get; set; }

Property Value

DiffDiskSettings

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. &lt;br&gt;&lt;br&gt; This value cannot be larger than 1023 GB

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="diskSizeGB")]
public Nullable<int> DiskSizeGB { get; set; }

Property Value

Nullable<Int32>

EncryptionSettings

Gets or sets specifies the encryption settings for the OS Disk. &lt;br&gt;&lt;br&gt; Minimum api-version: 2015-06-15

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="encryptionSettings")]
public Microsoft.Azure.Management.Compute.Models.DiskEncryptionSettings EncryptionSettings { get; set; }

Property Value

DiskEncryptionSettings

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.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="image")]
public Microsoft.Azure.Management.Compute.Models.VirtualHardDisk Image { get; set; }

Property Value

VirtualHardDisk

ManagedDisk

Gets or sets the managed disk parameters.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="managedDisk")]
public Microsoft.Azure.Management.Compute.Models.ManagedDiskParameters ManagedDisk { get; set; }

Property Value

ManagedDiskParameters

Name

Gets or sets the disk name.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="name")]
public string Name { get; set; }

Property Value

String

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'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="osType")]
public Nullable<Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes> OsType { get; set; }

Property Value

Nullable<OperatingSystemTypes>

Vhd

Gets or sets the virtual hard disk.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="vhd")]
public Microsoft.Azure.Management.Compute.Models.VirtualHardDisk Vhd { get; set; }

Property Value

VirtualHardDisk

WriteAcceleratorEnabled

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="writeAcceleratorEnabled")]
public Nullable<bool> WriteAcceleratorEnabled { get; set; }

Property Value

Nullable<Boolean>

Methods

Validate()

Validate the object.

Declaration

public virtual void Validate ();

Exceptions

ValidationException Thrown if validation fails