Class VirtualMachineScaleSet

Describes a Virtual Machine Scale Set.

Inheritance
Object
Resource
VirtualMachineScaleSet
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Microsoft.Azure.Management.Compute.dll
Syntax
[Microsoft.Rest.Serialization.JsonTransformation]
public class VirtualMachineScaleSet : Microsoft.Azure.Management.Compute.Models.Resource

Constructors

VirtualMachineScaleSet()

Initializes a new instance of the VirtualMachineScaleSet class.

Declaration
public VirtualMachineScaleSet ();

VirtualMachineScaleSet(String, String, String, String, IDictionary<String,String>, Sku, Plan, UpgradePolicy, VirtualMachineScaleSetVMProfile, String, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, SubResource, AdditionalCapabilities, VirtualMachineScaleSetIdentity, IList<String>)

Initializes a new instance of the VirtualMachineScaleSet class.

Declaration
public VirtualMachineScaleSet (string location, string id = null, string name = null, string type = null, System.Collections.Generic.IDictionary<string,string> tags = null, Microsoft.Azure.Management.Compute.Models.Sku sku = null, Microsoft.Azure.Management.Compute.Models.Plan plan = null, Microsoft.Azure.Management.Compute.Models.UpgradePolicy upgradePolicy = null, Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetVMProfile virtualMachineProfile = null, string provisioningState = null, Nullable<bool> overprovision = null, Nullable<bool> doNotRunExtensionsOnOverprovisionedVMs = null, string uniqueId = null, Nullable<bool> singlePlacementGroup = null, Nullable<bool> zoneBalance = null, Nullable<int> platformFaultDomainCount = null, Microsoft.Azure.Management.Compute.Models.SubResource proximityPlacementGroup = null, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities = null, Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIdentity identity = null, System.Collections.Generic.IList<string> zones = null);
Parameters
String location

Resource location
String id

Resource Id
String name

Resource name
String type

Resource type
IDictionary<String,String> tags

Resource tags
Sku sku

The virtual machine scale set sku.
Plan plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
UpgradePolicy upgradePolicy

The upgrade policy.
VirtualMachineScaleSetVMProfile virtualMachineProfile

The virtual machine profile.
String provisioningState

The provisioning state, which only appears in the response.
Nullable<Boolean> overprovision

Specifies whether the Virtual Machine Scale Set should be overprovisioned.
Nullable<Boolean> doNotRunExtensionsOnOverprovisionedVMs

When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.
String uniqueId

Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
Nullable<Boolean> singlePlacementGroup

When true this limits the scale set to a single placement group, of max size 100 virtual machines.
Nullable<Boolean> zoneBalance

Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.
Nullable<Int32> platformFaultDomainCount

Fault Domain count for each placement group.
SubResource proximityPlacementGroup

Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. <br><br>Minimum api-version: 2018-04-01.
AdditionalCapabilities additionalCapabilities

Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
VirtualMachineScaleSetIdentity identity

The identity of the virtual machine scale set, if configured.
IList<String> zones

The virtual machine scale set zones.

Properties

AdditionalCapabilities

Gets or sets specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.additionalCapabilities")]
public Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities AdditionalCapabilities { get; set; }
Property Value
AdditionalCapabilities

DoNotRunExtensionsOnOverprovisionedVMs

Gets or sets when Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.doNotRunExtensionsOnOverprovisionedVMs")]
public Nullable<bool> DoNotRunExtensionsOnOverprovisionedVMs { get; set; }
Property Value
Nullable<Boolean>

Identity

Gets or sets the identity of the virtual machine scale set, if configured.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="identity")]
public Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIdentity Identity { get; set; }
Property Value
VirtualMachineScaleSetIdentity

Overprovision

Gets or sets specifies whether the Virtual Machine Scale Set should be overprovisioned.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.overprovision")]
public Nullable<bool> Overprovision { get; set; }
Property Value
Nullable<Boolean>

Plan

Gets or sets specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started -&gt;. Enter any required information and then click Save.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="plan")]
public Microsoft.Azure.Management.Compute.Models.Plan Plan { get; set; }
Property Value
Plan

PlatformFaultDomainCount

Gets or sets fault Domain count for each placement group.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.platformFaultDomainCount")]
public Nullable<int> PlatformFaultDomainCount { get; set; }
Property Value
Nullable<Int32>

ProvisioningState

Gets the provisioning state, which only appears in the response.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.provisioningState")]
public string ProvisioningState { get; }
Property Value
String

ProximityPlacementGroup

Gets or sets specifies information about the proximity placement group that the virtual machine scale set should be assigned to. &lt;br&gt;&lt;br&gt;Minimum api-version: 2018-04-01.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.proximityPlacementGroup")]
public Microsoft.Azure.Management.Compute.Models.SubResource ProximityPlacementGroup { get; set; }
Property Value
SubResource

SinglePlacementGroup

Gets or sets when true this limits the scale set to a single placement group, of max size 100 virtual machines.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.singlePlacementGroup")]
public Nullable<bool> SinglePlacementGroup { get; set; }
Property Value
Nullable<Boolean>

Sku

Gets or sets the virtual machine scale set sku.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="sku")]
public Microsoft.Azure.Management.Compute.Models.Sku Sku { get; set; }
Property Value
Sku

UniqueId

Gets specifies the ID which uniquely identifies a Virtual Machine Scale Set.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.uniqueId")]
public string UniqueId { get; }
Property Value
String

UpgradePolicy

Gets or sets the upgrade policy.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.upgradePolicy")]
public Microsoft.Azure.Management.Compute.Models.UpgradePolicy UpgradePolicy { get; set; }
Property Value
UpgradePolicy

VirtualMachineProfile

Gets or sets the virtual machine profile.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.virtualMachineProfile")]
public Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetVMProfile VirtualMachineProfile { get; set; }
Property Value
VirtualMachineScaleSetVMProfile

ZoneBalance

Gets or sets whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.zoneBalance")]
public Nullable<bool> ZoneBalance { get; set; }
Property Value
Nullable<Boolean>

Zones

Gets or sets the virtual machine scale set zones.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="zones")]
public System.Collections.Generic.IList<string> Zones { get; set; }
Property Value
IList<String>

Methods

Validate()

Validate the object.

Declaration
public override void Validate ();
Exceptions
ValidationException

Thrown if validation fails