Class VirtualMachineScaleSetOSDisk

Describes a virtual machine scale set operating system disk.

Inheritance

Object

VirtualMachineScaleSetOSDisk

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.Management.Compute.dll

Syntax

public class VirtualMachineScaleSetOSDisk

Constructors

VirtualMachineScaleSetOSDisk()

Initializes a new instance of the VirtualMachineScaleSetOSDisk class.

Declaration

public VirtualMachineScaleSetOSDisk ();

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

Initializes a new instance of the VirtualMachineScaleSetOSDisk class.

Declaration

public VirtualMachineScaleSetOSDisk (string createOption, string name = 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, Nullable<Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes> osType = null, Microsoft.Azure.Management.Compute.Models.VirtualHardDisk image = null, System.Collections.Generic.IList<string> vhdContainers = null, Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetManagedDiskParameters managedDisk = null);

Parameters

String createOption Specifies how the virtual machines in the scale set should be created.<br><br> The only allowed value is: 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'

String name The disk name.

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

Nullable<Int32> diskSizeGB Specifies the size of the operating system 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

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'

VirtualHardDisk image Specifies information about the unmanaged user image to base the scale set on.

IList<String> vhdContainers Specifies the container urls that are used to store operating system disks for the scale set.

VirtualMachineScaleSetManagedDiskParameters 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 machines in the scale set should be created.&lt;br&gt;&lt;br&gt; The only allowed value is: 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 scale set.

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 the operating system 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>

Image

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

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.VirtualMachineScaleSetManagedDiskParameters ManagedDisk { get; set; }

Property Value

VirtualMachineScaleSetManagedDiskParameters

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>

VhdContainers

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="vhdContainers")]
public System.Collections.Generic.IList<string> VhdContainers { get; set; }

Property Value

IList<String>

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