azure.mgmt.compute.types.VirtualMachineScaleSetProperties class

Constructor

VirtualMachineScaleSetProperties()

Variables

Name	Description
upgrade_policy	<xref:<xref:"UpgradePolicy">> The upgrade policy.
scheduled_events_policy	<xref:<xref:"ScheduledEventsPolicy">> The ScheduledEventsPolicy.
automatic_repairs_policy	<xref:<xref:"AutomaticRepairsPolicy">> Policy for automatic repairs.
virtual_machine_profile	<xref:<xref:"VirtualMachineScaleSetVMProfile">> The virtual machine profile.
provisioning_state	str The provisioning state, which only appears in the response.
overprovision	bool Specifies whether the Virtual Machine Scale Set should be overprovisioned.
do_not_run_extensions_on_overprovisioned_v_ms	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.
unique_id	str Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
single_placement_group	bool 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.
zone_balance	bool 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.
platform_fault_domain_count	int Fault Domain count for each placement group.
proximity_placement_group	<xref:<xref:"SubResource">> Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.
host_group	<xref:<xref:"SubResource">> Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.
additional_capabilities	<xref:<xref:"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.
scale_in_policy	<xref:<xref:"ScaleInPolicy">> Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
orchestration_mode	Union[str, <xref:"OrchestrationMode">] Specifies the orchestration mode for the virtual machine scale set. Known values are: "Uniform" and "Flexible".
spot_restore_policy	<xref:<xref:"SpotRestorePolicy">> Specifies the Spot Restore properties for the virtual machine scale set.
priority_mix_policy	<xref:<xref:"PriorityMixPolicy">> Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
time_created	str Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01.
constrained_maximum_capacity	bool Optional property which must either be set to True or omitted.
resiliency_policy	<xref:<xref:"ResiliencyPolicy">> Policy for Resiliency.
zonal_platform_fault_domain_align_mode	Union[str, <xref:"ZonalPlatformFaultDomainAlignMode">] Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. Known values are: "Aligned", "Unaligned", and "BestEffortAligned".
sku_profile	<xref:<xref:"SkuProfile">> Specifies the sku profile for the virtual machine scale set.
high_speed_interconnect_placement	Union[str, <xref:"HighSpeedInterconnectPlacement">] Specifies the high speed interconnect placement for the virtual machine scale set. Known values are: "None" and "Trunk".
lifecycle_hooks_profile	<xref:<xref:"LifecycleHooksProfile">> Specifies the lifecycle hooks profile for the virtual machine scale set.
external_health_policy	<xref:<xref:"ExternalHealthPolicy">> Specifies the external health policy for the virtual machine scale set.

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.

additionalCapabilities: AdditionalCapabilities

automaticRepairsPolicy

Policy for automatic repairs.

automaticRepairsPolicy: AutomaticRepairsPolicy

constrainedMaximumCapacity

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

constrainedMaximumCapacity: bool

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.

doNotRunExtensionsOnOverprovisionedVMs: bool

externalHealthPolicy

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

externalHealthPolicy: ExternalHealthPolicy

highSpeedInterconnectPlacement

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

highSpeedInterconnectPlacement: str | HighSpeedInterconnectPlacement

hostGroup

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

hostGroup: SubResource

lifecycleHooksProfile

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

lifecycleHooksProfile: LifecycleHooksProfile

orchestrationMode

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

orchestrationMode: str | OrchestrationMode

overprovision

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

overprovision: bool

platformFaultDomainCount

Fault Domain count for each placement group.

platformFaultDomainCount: int

priorityMixPolicy

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

priorityMixPolicy: PriorityMixPolicy

provisioningState

The provisioning state, which only appears in the response.

provisioningState: str

proximityPlacementGroup

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

resiliencyPolicy

Policy for Resiliency.

resiliencyPolicy: ResiliencyPolicy

scaleInPolicy

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

scaleInPolicy: ScaleInPolicy

scheduledEventsPolicy

The ScheduledEventsPolicy.

scheduledEventsPolicy: 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.

singlePlacementGroup: bool

skuProfile

Specifies the sku profile for the virtual machine scale set.

skuProfile: SkuProfile

spotRestorePolicy

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

spotRestorePolicy: SpotRestorePolicy

timeCreated

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

timeCreated: str

uniqueId

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

uniqueId: str

upgradePolicy

The upgrade policy.

upgradePolicy: UpgradePolicy

virtualMachineProfile

The virtual machine profile.

virtualMachineProfile: VirtualMachineScaleSetVMProfile

zonalPlatformFaultDomainAlignMode

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

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.

zoneBalance: bool