azure.mgmt.compute.v2024_03_01.models.VirtualMachineScaleSet.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2024_03_01.models.VirtualMachineScaleSet
name: VirtualMachineScaleSet
fullName: azure.mgmt.compute.v2024_03_01.models.VirtualMachineScaleSet
module: azure.mgmt.compute.v2024_03_01.models
inheritances:
- azure.mgmt.compute.v2024_03_01.models._models_py3.Resource
summary: 'Describes a Virtual Machine Scale Set.


  Variables are only populated by the server, and will be ignored when sending a request.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'VirtualMachineScaleSet(*, location: str, tags: Dict[str, str] | None =
    None, sku: _models.Sku | None = None, plan: _models.Plan | None = None, identity:
    _models.VirtualMachineScaleSetIdentity | None = None, zones: List[str] | None
    = None, extended_location: _models.ExtendedLocation | None = None, upgrade_policy:
    _models.UpgradePolicy | None = None, scheduled_events_policy: _models.ScheduledEventsPolicy
    | None = None, automatic_repairs_policy: _models.AutomaticRepairsPolicy | None
    = None, virtual_machine_profile: _models.VirtualMachineScaleSetVMProfile | None
    = None, overprovision: bool | None = None, do_not_run_extensions_on_overprovisioned_v_ms:
    bool | None = None, single_placement_group: bool | None = None, zone_balance:
    bool | None = None, platform_fault_domain_count: int | None = None, proximity_placement_group:
    _models.SubResource | None = None, host_group: _models.SubResource | None = None,
    additional_capabilities: _models.AdditionalCapabilities | None = None, scale_in_policy:
    _models.ScaleInPolicy | None = None, orchestration_mode: str | _models.OrchestrationMode
    | None = None, spot_restore_policy: _models.SpotRestorePolicy | None = None, priority_mix_policy:
    _models.PriorityMixPolicy | None = None, constrained_maximum_capacity: bool |
    None = None, resiliency_policy: _models.ResiliencyPolicy | None = None, **kwargs:
    Any)'
  keywordOnlyParameters:
  - name: location
    description: Resource location. Required.
    types:
    - <xref:str>
  - name: tags
    description: Resource tags.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: sku
    description: The virtual machine scale set sku.
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.Sku>
  - name: plan
    description: '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**.'
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.Plan>
  - name: identity
    description: The identity of the virtual machine scale set, if configured.
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.VirtualMachineScaleSetIdentity>
  - name: zones
    description: 'The virtual machine scale set zones. NOTE: Availability zones can
      only be set

      when you create the scale set.'
    types:
    - <xref:list>[<xref:str>]
  - name: extended_location
    description: The extended location of the Virtual Machine Scale Set.
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.ExtendedLocation>
  - name: upgrade_policy
    description: The upgrade policy.
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.UpgradePolicy>
  - name: scheduled_events_policy
    description: The ScheduledEventsPolicy.
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.ScheduledEventsPolicy>
  - name: automatic_repairs_policy
    description: Policy for automatic repairs.
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.AutomaticRepairsPolicy>
  - name: virtual_machine_profile
    description: The virtual machine profile.
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.VirtualMachineScaleSetVMProfile>
  - name: overprovision
    description: 'Specifies whether the Virtual Machine Scale Set should be

      overprovisioned.'
    types:
    - <xref:bool>
  - name: do_not_run_extensions_on_overprovisioned_v_ms
    description: '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.'
    types:
    - <xref:bool>
  - name: single_placement_group
    description: '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.'
    types:
    - <xref:bool>
  - name: zone_balance
    description: '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.'
    types:
    - <xref:bool>
  - name: platform_fault_domain_count
    description: Fault Domain count for each placement group.
    types:
    - <xref:int>
  - name: proximity_placement_group
    description: 'Specifies information about the proximity placement group

      that the virtual machine scale set should be assigned to. Minimum api-version:
      2018-04-01.'
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.SubResource>
  - name: host_group
    description: 'Specifies information about the dedicated host group that the virtual

      machine scale set resides in. Minimum api-version: 2020-06-01.'
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.SubResource>
  - name: additional_capabilities
    description: '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.'
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.AdditionalCapabilities>
  - name: scale_in_policy
    description: 'Specifies the policies applied when scaling in Virtual Machines
      in

      the Virtual Machine Scale Set.'
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.ScaleInPolicy>
  - name: orchestration_mode
    description: 'Specifies the orchestration mode for the virtual machine scale

      set. Known values are: "Uniform" and "Flexible".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2024_03_01.models.OrchestrationMode>
  - name: spot_restore_policy
    description: 'Specifies the Spot Restore properties for the virtual machine

      scale set.'
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.SpotRestorePolicy>
  - name: priority_mix_policy
    description: 'Specifies the desired targets for mixing Spot and Regular

      priority VMs within the same VMSS Flex instance.'
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.PriorityMixPolicy>
  - name: constrained_maximum_capacity
    description: 'Optional property which must either be set to True or

      omitted.'
    types:
    - <xref:bool>
  - name: resiliency_policy
    description: Policy for Resiliency.
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.ResiliencyPolicy>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource name.
  name: name
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: Resource location. Required.
  name: location
  types:
  - <xref:str>
- description: Resource tags.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: The virtual machine scale set sku.
  name: sku
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.Sku>
- description: '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**.'
  name: plan
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.Plan>
- description: The identity of the virtual machine scale set, if configured.
  name: identity
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.VirtualMachineScaleSetIdentity>
- description: 'The virtual machine scale set zones. NOTE: Availability zones can
    only be set when

    you create the scale set.'
  name: zones
  types:
  - <xref:list>[<xref:str>]
- description: The extended location of the Virtual Machine Scale Set.
  name: extended_location
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.ExtendedLocation>
- description: '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.'
  name: etag
  types:
  - <xref:str>
- description: The upgrade policy.
  name: upgrade_policy
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.UpgradePolicy>
- description: The ScheduledEventsPolicy.
  name: scheduled_events_policy
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.ScheduledEventsPolicy>
- description: Policy for automatic repairs.
  name: automatic_repairs_policy
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.AutomaticRepairsPolicy>
- description: The virtual machine profile.
  name: virtual_machine_profile
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.VirtualMachineScaleSetVMProfile>
- description: The provisioning state, which only appears in the response.
  name: provisioning_state
  types:
  - <xref:str>
- description: Specifies whether the Virtual Machine Scale Set should be overprovisioned.
  name: overprovision
  types:
  - <xref:bool>
- description: '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.'
  name: do_not_run_extensions_on_overprovisioned_v_ms
  types:
  - <xref:bool>
- description: Specifies the ID which uniquely identifies a Virtual Machine Scale
    Set.
  name: unique_id
  types:
  - <xref:str>
- description: '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.'
  name: single_placement_group
  types:
  - <xref:bool>
- description: '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.'
  name: zone_balance
  types:
  - <xref:bool>
- description: Fault Domain count for each placement group.
  name: platform_fault_domain_count
  types:
  - <xref:int>
- description: 'Specifies information about the proximity placement group that

    the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.'
  name: proximity_placement_group
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.SubResource>
- description: 'Specifies information about the dedicated host group that the virtual
    machine

    scale set resides in. Minimum api-version: 2020-06-01.'
  name: host_group
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.SubResource>
- description: '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.'
  name: additional_capabilities
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.AdditionalCapabilities>
- description: 'Specifies the policies applied when scaling in Virtual Machines in
    the

    Virtual Machine Scale Set.'
  name: scale_in_policy
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.ScaleInPolicy>
- description: 'Specifies the orchestration mode for the virtual machine scale set.

    Known values are: "Uniform" and "Flexible".'
  name: orchestration_mode
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2024_03_01.models.OrchestrationMode>
- description: 'Specifies the Spot Restore properties for the virtual machine scale

    set.'
  name: spot_restore_policy
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.SpotRestorePolicy>
- description: 'Specifies the desired targets for mixing Spot and Regular priority

    VMs within the same VMSS Flex instance.'
  name: priority_mix_policy
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.PriorityMixPolicy>
- description: 'Specifies the time at which the Virtual Machine Scale Set resource
    was

    created. Minimum api-version: 2021-11-01.'
  name: time_created
  types:
  - <xref:datetime.datetime>
- description: 'Optional property which must either be set to True or

    omitted.'
  name: constrained_maximum_capacity
  types:
  - <xref:bool>
- description: Policy for Resiliency.
  name: resiliency_policy
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.ResiliencyPolicy>