VirtualMachineScaleSet Class

Definition

Describes a Virtual Machine Scale Set.

[Microsoft.Rest.Serialization.JsonTransformation]
public class VirtualMachineScaleSet : Microsoft.Azure.Management.Compute.Models.Resource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type VirtualMachineScaleSet = class
    inherit Resource
Public Class VirtualMachineScaleSet
Inherits Resource
Inheritance
System.Object
VirtualMachineScaleSet
Attributes

Constructors

VirtualMachineScaleSet()

Initializes a new instance of the VirtualMachineScaleSet class.

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

Initializes a new instance of the VirtualMachineScaleSet class.

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

Initializes a new instance of the VirtualMachineScaleSet class.

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

Initializes a new instance of the VirtualMachineScaleSet class.

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

Initializes a new instance of the VirtualMachineScaleSet class.

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

Initializes a new instance of the VirtualMachineScaleSet class.

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.

AutomaticRepairsPolicy

Gets or sets policy for automatic repairs.

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.

ExtendedLocation

Gets or sets the extended location of the Virtual Machine Scale Set.

HostGroup

Gets or sets specifies information about the dedicated host group that the virtual machine scale set resides in. &lt;br&gt;&lt;br&gt;Minimum api-version: 2020-06-01.

Id

Gets resource Id

(Inherited from Resource)
Identity

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

Location

Gets or sets resource location

(Inherited from Resource)
Name

Gets resource name

(Inherited from Resource)
OrchestrationMode

Gets or sets specifies the orchestration mode for the virtual machine scale set. Possible values include: 'Uniform', 'Flexible'

Overprovision

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

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.

PlatformFaultDomainCount

Gets or sets fault Domain count for each placement group.

ProvisioningState

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

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.

ScaleInPolicy

Gets or sets specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.

SinglePlacementGroup

Gets or sets when true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.

Sku

Gets or sets the virtual machine scale set sku.

SpotRestorePolicy

Gets or sets specifies the Spot Restore properties for the virtual machine scale set.

Tags

Gets or sets resource tags

(Inherited from Resource)
Type

Gets resource type

(Inherited from Resource)
UniqueId

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

UpgradePolicy

Gets or sets the upgrade policy.

VirtualMachineProfile

Gets or sets the virtual machine profile.

ZoneBalance

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

Zones

Gets or sets the virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set

Methods

Validate()

Validate the object.

Applies to