azure.mgmt.compute.v2017_12_01.operations.VirtualMachineScaleSetRollingUpgradesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2017_12_01.operations.VirtualMachineScaleSetRollingUpgradesOperations
name: VirtualMachineScaleSetRollingUpgradesOperations
fullName: azure.mgmt.compute.v2017_12_01.operations.VirtualMachineScaleSetRollingUpgradesOperations
module: azure.mgmt.compute.v2017_12_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.compute.v2017_12_01.ComputeManagementClient>'s\n\
  >\n> <xref:virtual_machine_scale_set_rolling_upgrades> attribute.\n>"
constructor:
  syntax: VirtualMachineScaleSetRollingUpgradesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2017_12_01.operations.VirtualMachineScaleSetRollingUpgradesOperations.begin_cancel
  name: begin_cancel
  summary: Cancels the current virtual machine scale set rolling upgrade.
  signature: 'begin_cancel(resource_group_name: str, vm_scale_set_name: str, **kwargs:
    Any) -> LROPoller[OperationStatusResponse]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: 'An instance of LROPoller that returns either OperationStatusResponse
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2017_12_01.models.OperationStatusResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2017_12_01.operations.VirtualMachineScaleSetRollingUpgradesOperations.begin_start_os_upgrade
  name: begin_start_os_upgrade
  summary: 'Starts a rolling upgrade to move all virtual machine scale set instances
    to the latest

    available Platform Image OS version. Instances which are already running the latest
    available

    OS version are not affected.'
  signature: 'begin_start_os_upgrade(resource_group_name: str, vm_scale_set_name:
    str, **kwargs: Any) -> LROPoller[OperationStatusResponse]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: 'An instance of LROPoller that returns either OperationStatusResponse
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2017_12_01.models.OperationStatusResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2017_12_01.operations.VirtualMachineScaleSetRollingUpgradesOperations.get_latest
  name: get_latest
  summary: Gets the status of the latest virtual machine scale set rolling upgrade.
  signature: 'get_latest(resource_group_name: str, vm_scale_set_name: str, **kwargs:
    Any) -> RollingUpgradeStatusInfo'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: RollingUpgradeStatusInfo or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2017_12_01.models.RollingUpgradeStatusInfo>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2017_12_01.operations.VirtualMachineScaleSetRollingUpgradesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.compute.v2017_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2017_12_01\\models\\__init__.py'>