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.

additional_capabilities: _models.AdditionalCapabilities | None

Policy for automatic repairs.

automatic_repairs_policy: _models.AutomaticRepairsPolicy | None

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

constrained_maximum_capacity: bool | None

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.

do_not_run_extensions_on_overprovisioned_v_ms: bool | None

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

external_health_policy: _models.ExternalHealthPolicy | None

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

high_speed_interconnect_placement: str | _models.HighSpeedInterconnectPlacement | None

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

host_group: _models.SubResource | None

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

lifecycle_hooks_profile: _models.LifecycleHooksProfile | None

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

orchestration_mode: str | _models.OrchestrationMode | None

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

overprovision: bool | None

Fault Domain count for each placement group.

platform_fault_domain_count: int | None

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

priority_mix_policy: _models.PriorityMixPolicy | None

The provisioning state, which only appears in the response.

provisioning_state: str | None

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

proximity_placement_group: _models.SubResource | None

Policy for Resiliency.

resiliency_policy: _models.ResiliencyPolicy | None

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

scale_in_policy: _models.ScaleInPolicy | None

The ScheduledEventsPolicy.

scheduled_events_policy: _models.ScheduledEventsPolicy | None

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.

single_placement_group: bool | None

Specifies the sku profile for the virtual machine scale set.

sku_profile: _models.SkuProfile | None

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

spot_restore_policy: _models.SpotRestorePolicy | None

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

time_created: datetime | None

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

unique_id: str | None

The upgrade policy.

upgrade_policy: _models.UpgradePolicy | None

The virtual machine profile.

virtual_machine_profile: _models.VirtualMachineScaleSetVMProfile | None

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

zonal_platform_fault_domain_align_mode: str | _models.ZonalPlatformFaultDomainAlignMode | None

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.

zone_balance: bool | None