azure.mgmt.compute.v2024_03_01.models.VirtualMachineScaleSetUpdate.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2024_03_01.models.VirtualMachineScaleSetUpdate
name: VirtualMachineScaleSetUpdate
fullName: azure.mgmt.compute.v2024_03_01.models.VirtualMachineScaleSetUpdate
module: azure.mgmt.compute.v2024_03_01.models
inheritances:
- azure.mgmt.compute.v2024_03_01.models._models_py3.UpdateResource
summary: Describes a Virtual Machine Scale Set.
constructor:
  syntax: 'VirtualMachineScaleSetUpdate(*, tags: Dict[str, str] | None = None, sku:
    _models.Sku | None = None, plan: _models.Plan | None = None, identity: _models.VirtualMachineScaleSetIdentity
    | None = None, upgrade_policy: _models.UpgradePolicy | None = None, automatic_repairs_policy:
    _models.AutomaticRepairsPolicy | None = None, virtual_machine_profile: _models.VirtualMachineScaleSetUpdateVMProfile
    | None = None, overprovision: bool | None = None, do_not_run_extensions_on_overprovisioned_v_ms:
    bool | None = None, single_placement_group: bool | None = None, additional_capabilities:
    _models.AdditionalCapabilities | None = None, scale_in_policy: _models.ScaleInPolicy
    | None = None, proximity_placement_group: _models.SubResource | None = None, priority_mix_policy:
    _models.PriorityMixPolicy | None = None, spot_restore_policy: _models.SpotRestorePolicy
    | None = None, resiliency_policy: _models.ResiliencyPolicy | None = None, **kwargs:
    Any)'
  keywordOnlyParameters:
  - 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: 'The purchase plan when deploying a virtual machine scale set from
      VM Marketplace

      images.'
    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: upgrade_policy
    description: The upgrade policy.
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.UpgradePolicy>
  - 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.VirtualMachineScaleSetUpdateVMProfile>
  - 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: 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: proximity_placement_group
    description: 'Specifies information about the proximity placement group

      that the virtual machine scale set should be assigned to. `<br>`:code:>>`<<<br>`Minimum

      api-version: 2018-04-01.'
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.SubResource>
  - 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: 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: resiliency_policy
    description: Policy for Resiliency.
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.ResiliencyPolicy>
variables:
- 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: 'The purchase plan when deploying a virtual machine scale set from
    VM Marketplace

    images.'
  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 upgrade policy.
  name: upgrade_policy
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.UpgradePolicy>
- 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.VirtualMachineScaleSetUpdateVMProfile>
- 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: '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: '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 information about the proximity placement group that

    the virtual machine scale set should be assigned to. `<br>`:code:>>`<<<br>`Minimum

    api-version: 2018-04-01.'
  name: proximity_placement_group
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.SubResource>
- 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 Spot Restore properties for the virtual machine scale

    set.'
  name: spot_restore_policy
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.SpotRestorePolicy>
- description: Policy for Resiliency.
  name: resiliency_policy
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.ResiliencyPolicy>