VirtualMachineScaleSetProperties Class

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.

additionalCapabilities: AdditionalCapabilities

Policy for automatic repairs.

automaticRepairsPolicy: AutomaticRepairsPolicy

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

constrainedMaximumCapacity: bool

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.

doNotRunExtensionsOnOverprovisionedVMs: bool

Specifies the external health policy for the virtual machine scale set.

externalHealthPolicy: ExternalHealthPolicy

Specifies the high speed interconnect placement for the virtual machine scale set. Known values are: "None" and "Trunk".

highSpeedInterconnectPlacement: str | HighSpeedInterconnectPlacement

Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.

hostGroup: SubResource

Specifies the lifecycle hooks profile for the virtual machine scale set.

lifecycleHooksProfile: LifecycleHooksProfile

Specifies the orchestration mode for the virtual machine scale set. Known values are: "Uniform" and "Flexible".

orchestrationMode: str | OrchestrationMode

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

overprovision: bool

Fault Domain count for each placement group.

platformFaultDomainCount: int

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

priorityMixPolicy: PriorityMixPolicy

The provisioning state, which only appears in the response.

provisioningState: str

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

proximityPlacementGroup: SubResource

Policy for Resiliency.

resiliencyPolicy: ResiliencyPolicy

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

scaleInPolicy: ScaleInPolicy

The ScheduledEventsPolicy.

scheduledEventsPolicy: ScheduledEventsPolicy

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.

singlePlacementGroup: bool

Specifies the sku profile for the virtual machine scale set.

skuProfile: SkuProfile

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

spotRestorePolicy: SpotRestorePolicy

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

timeCreated: str

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

uniqueId: str

The upgrade policy.

upgradePolicy: UpgradePolicy

The virtual machine profile.

virtualMachineProfile: VirtualMachineScaleSetVMProfile

Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. Known values are: "Aligned", "Unaligned", and "BestEffortAligned".

zonalPlatformFaultDomainAlignMode: str | ZonalPlatformFaultDomainAlignMode

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.

zoneBalance: bool