VirtualMachineScaleSetData Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A class representing the VirtualMachineScaleSet data model. Describes a Virtual Machine Scale Set.
public class VirtualMachineScaleSetData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.VirtualMachineScaleSetData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.VirtualMachineScaleSetData>
type VirtualMachineScaleSetData = class
inherit TrackedResourceData
interface IJsonModel<VirtualMachineScaleSetData>
interface IPersistableModel<VirtualMachineScaleSetData>
Public Class VirtualMachineScaleSetData
Inherits TrackedResourceData
Implements IJsonModel(Of VirtualMachineScaleSetData), IPersistableModel(Of VirtualMachineScaleSetData)
- Inheritance
- Implements
Constructors
VirtualMachineScaleSetData(AzureLocation) |
Initializes a new instance of VirtualMachineScaleSetData. |
Properties
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. |
AutomaticRepairsPolicy |
Policy for automatic repairs. |
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. |
ETag |
Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates. |
ExtendedLocation |
The extended location of the Virtual Machine Scale Set. |
HostGroupId |
Gets or sets Id. |
Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData) |
Identity |
The identity of the virtual machine scale set, if configured. |
IsMaximumCapacityConstrained |
Optional property which must either be set to True or omitted. |
Location |
The geo-location where the resource lives. (Inherited from TrackedResourceData) |
Name |
The name of the resource. (Inherited from ResourceData) |
OrchestrationMode |
Specifies the orchestration mode for the virtual machine scale set. |
Overprovision |
Specifies whether the Virtual Machine Scale Set should be overprovisioned. |
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. |
PlatformFaultDomainCount |
Fault Domain count for each placement group. |
PriorityMixPolicy |
Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. |
ProvisioningState |
The provisioning state, which only appears in the response. |
ProximityPlacementGroupId |
Gets or sets Id. |
ResiliencyPolicy |
Policy for Resiliency. |
ResourceType |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData) |
ScaleInPolicy |
Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. |
ScheduledEventsPolicy |
The ScheduledEventsPolicy. |
SinglePlacementGroup |
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 |
The virtual machine scale set sku. |
SkuProfile |
Specifies the sku profile for the virtual machine scale set. |
SpotRestorePolicy |
Specifies the Spot Restore properties for the virtual machine scale set. |
SystemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData) |
Tags |
Resource tags. (Inherited from TrackedResourceData) |
TimeCreated |
Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. |
UniqueId |
Specifies the ID which uniquely identifies a Virtual Machine Scale Set. |
UpgradePolicy |
The upgrade policy. |
VirtualMachineProfile |
The virtual machine profile. |
ZonalPlatformFaultDomainAlignMode |
Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. |
ZoneBalance |
Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. |
Zones |
The virtual machine scale set zones. |
Methods
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | (Inherited from TrackedResourceData) |
Explicit Interface Implementations
IJsonModel<VirtualMachineScaleSetData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<VirtualMachineScaleSetData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<VirtualMachineScaleSetData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<VirtualMachineScaleSetData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<VirtualMachineScaleSetData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |