ArmComputeModelFactory.VirtualMachineScaleSetData Method

Reference

Definition

Namespace:: Azure.ResourceManager.Compute.Models

Assembly:: Azure.ResourceManager.Compute.dll

Package:: Azure.ResourceManager.Compute v1.6.0

Package:: Azure.ResourceManager.Compute v1.7.0-beta.1

Source:: ArmComputeModelFactory.cs

Source:: ArmComputeModelFactory.cs

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.

Initializes a new instance of VirtualMachineScaleSetData.

public static Azure.ResourceManager.Compute.VirtualMachineScaleSetData VirtualMachineScaleSetData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation location = default, Azure.ResourceManager.Compute.Models.ComputeSku sku = default, Azure.ResourceManager.Compute.Models.ComputePlan plan = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, System.Collections.Generic.IEnumerable<string> zones = default, Azure.ResourceManager.Resources.Models.ExtendedLocation extendedLocation = default, string etag = default, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetUpgradePolicy upgradePolicy = default, Azure.ResourceManager.Compute.Models.ScheduledEventsPolicy scheduledEventsPolicy = default, Azure.ResourceManager.Compute.Models.AutomaticRepairsPolicy automaticRepairsPolicy = default, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmProfile virtualMachineProfile = default, string provisioningState = default, bool? overprovision = default, bool? doNotRunExtensionsOnOverprovisionedVms = default, string uniqueId = default, bool? singlePlacementGroup = default, bool? zoneBalance = default, int? platformFaultDomainCount = default, Azure.Core.ResourceIdentifier proximityPlacementGroupId = default, Azure.Core.ResourceIdentifier hostGroupId = default, Azure.ResourceManager.Compute.Models.AdditionalCapabilities additionalCapabilities = default, Azure.ResourceManager.Compute.Models.ScaleInPolicy scaleInPolicy = default, Azure.ResourceManager.Compute.Models.OrchestrationMode? orchestrationMode = default, Azure.ResourceManager.Compute.Models.SpotRestorePolicy spotRestorePolicy = default, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetPriorityMixPolicy priorityMixPolicy = default, DateTimeOffset? timeCreated = default, bool? isMaximumCapacityConstrained = default, Azure.ResourceManager.Compute.Models.ResiliencyPolicy resiliencyPolicy = default, Azure.ResourceManager.Compute.Models.ZonalPlatformFaultDomainAlignMode? zonalPlatformFaultDomainAlignMode = default, Azure.ResourceManager.Compute.Models.ComputeSkuProfile skuProfile = default);

static member VirtualMachineScaleSetData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * Azure.ResourceManager.Compute.Models.ComputeSku * Azure.ResourceManager.Compute.Models.ComputePlan * Azure.ResourceManager.Models.ManagedServiceIdentity * seq<string> * Azure.ResourceManager.Resources.Models.ExtendedLocation * string * Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetUpgradePolicy * Azure.ResourceManager.Compute.Models.ScheduledEventsPolicy * Azure.ResourceManager.Compute.Models.AutomaticRepairsPolicy * Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmProfile * string * Nullable<bool> * Nullable<bool> * string * Nullable<bool> * Nullable<bool> * Nullable<int> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Azure.ResourceManager.Compute.Models.AdditionalCapabilities * Azure.ResourceManager.Compute.Models.ScaleInPolicy * Nullable<Azure.ResourceManager.Compute.Models.OrchestrationMode> * Azure.ResourceManager.Compute.Models.SpotRestorePolicy * Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetPriorityMixPolicy * Nullable<DateTimeOffset> * Nullable<bool> * Azure.ResourceManager.Compute.Models.ResiliencyPolicy * Nullable<Azure.ResourceManager.Compute.Models.ZonalPlatformFaultDomainAlignMode> * Azure.ResourceManager.Compute.Models.ComputeSkuProfile -> Azure.ResourceManager.Compute.VirtualMachineScaleSetData

Public Shared Function VirtualMachineScaleSetData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional location As AzureLocation = Nothing, Optional sku As ComputeSku = Nothing, Optional plan As ComputePlan = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional zones As IEnumerable(Of String) = Nothing, Optional extendedLocation As ExtendedLocation = Nothing, Optional etag As String = Nothing, Optional upgradePolicy As VirtualMachineScaleSetUpgradePolicy = Nothing, Optional scheduledEventsPolicy As ScheduledEventsPolicy = Nothing, Optional automaticRepairsPolicy As AutomaticRepairsPolicy = Nothing, Optional virtualMachineProfile As VirtualMachineScaleSetVmProfile = Nothing, Optional provisioningState As String = Nothing, Optional overprovision As Nullable(Of Boolean) = Nothing, Optional doNotRunExtensionsOnOverprovisionedVms As Nullable(Of Boolean) = Nothing, Optional uniqueId As String = Nothing, Optional singlePlacementGroup As Nullable(Of Boolean) = Nothing, Optional zoneBalance As Nullable(Of Boolean) = Nothing, Optional platformFaultDomainCount As Nullable(Of Integer) = Nothing, Optional proximityPlacementGroupId As ResourceIdentifier = Nothing, Optional hostGroupId As ResourceIdentifier = Nothing, Optional additionalCapabilities As AdditionalCapabilities = Nothing, Optional scaleInPolicy As ScaleInPolicy = Nothing, Optional orchestrationMode As Nullable(Of OrchestrationMode) = Nothing, Optional spotRestorePolicy As SpotRestorePolicy = Nothing, Optional priorityMixPolicy As VirtualMachineScaleSetPriorityMixPolicy = Nothing, Optional timeCreated As Nullable(Of DateTimeOffset) = Nothing, Optional isMaximumCapacityConstrained As Nullable(Of Boolean) = Nothing, Optional resiliencyPolicy As ResiliencyPolicy = Nothing, Optional zonalPlatformFaultDomainAlignMode As Nullable(Of ZonalPlatformFaultDomainAlignMode) = Nothing, Optional skuProfile As ComputeSkuProfile = Nothing) As VirtualMachineScaleSetData

Parameters

id: ResourceIdentifier

The id.

name: String

The name.

resourceType: ResourceType

The resourceType.

systemData: SystemData

The systemData.

tags: IDictionary<String,String>

The tags.

location: AzureLocation

The location.

sku: ComputeSku

The virtual machine scale set sku.

plan: ComputePlan

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.

identity: ManagedServiceIdentity

The identity of the virtual machine scale set, if configured.

zones: IEnumerable<String>

The virtual machine scale set zones.

extendedLocation: ExtendedLocation

The extended location of the Virtual Machine Scale Set.

etag: String

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.

upgradePolicy: VirtualMachineScaleSetUpgradePolicy

The upgrade policy.

scheduledEventsPolicy: ScheduledEventsPolicy

The ScheduledEventsPolicy.

automaticRepairsPolicy: AutomaticRepairsPolicy

Policy for automatic repairs.

virtualMachineProfile: VirtualMachineScaleSetVmProfile

The virtual machine profile.

provisioningState: String

The provisioning state, which only appears in the response.

overprovision: Nullable<Boolean>

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

doNotRunExtensionsOnOverprovisionedVms: Nullable<Boolean>

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.

uniqueId: String

Specifies the ID which uniquely identifies a Virtual Machine Scale Set.

singlePlacementGroup: Nullable<Boolean>

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.

zoneBalance: Nullable<Boolean>

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.

platformFaultDomainCount: Nullable<Int32>

Fault Domain count for each placement group.

proximityPlacementGroupId: ResourceIdentifier

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

hostGroupId: ResourceIdentifier

Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-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.

scaleInPolicy: ScaleInPolicy

Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.

orchestrationMode: Nullable<OrchestrationMode>

Specifies the orchestration mode for the virtual machine scale set.

spotRestorePolicy: SpotRestorePolicy

Specifies the Spot Restore properties for the virtual machine scale set.

priorityMixPolicy: VirtualMachineScaleSetPriorityMixPolicy

Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.

timeCreated: Nullable<DateTimeOffset>

Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01.

isMaximumCapacityConstrained: Nullable<Boolean>

Optional property which must either be set to True or omitted.

resiliencyPolicy: ResiliencyPolicy

Policy for Resiliency.

zonalPlatformFaultDomainAlignMode: Nullable<ZonalPlatformFaultDomainAlignMode>

Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.

skuProfile: ComputeSkuProfile

Specifies the sku profile for the virtual machine scale set.

Returns

VirtualMachineScaleSetData

A new VirtualMachineScaleSetData instance for mocking.

Applies to

Share via

ArmComputeModelFactory.VirtualMachineScaleSetData Method

Definition

Parameters

Returns

Applies to

Additional resources