VirtualMachineScaleSetRollingUpgradesOperations Class

VirtualMachineScaleSetRollingUpgradesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

VirtualMachineScaleSetRollingUpgradesOperations

Constructor

VirtualMachineScaleSetRollingUpgradesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_cancel	Cancels the current virtual machine scale set rolling upgrade.
begin_start_extension_upgrade	Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.
begin_start_os_upgrade	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.
get_latest	Gets the status of the latest virtual machine scale set rolling upgrade.

begin_cancel

Cancels the current virtual machine scale set rolling upgrade.

async begin_cancel(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

vm_scale_set_name

str

Required

The name of the VM scale set.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_start_extension_upgrade

Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.

async begin_start_extension_upgrade(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

vm_scale_set_name

str

Required

The name of the VM scale set.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_start_os_upgrade

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.

async begin_start_os_upgrade(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

vm_scale_set_name

str

Required

The name of the VM scale set.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get_latest

Gets the status of the latest virtual machine scale set rolling upgrade.

async get_latest(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any) -> azure.mgmt.compute.v2020_12_01.models._models_py3.RollingUpgradeStatusInfo

Parameters

resource_group_name

str

Required

The name of the resource group.

vm_scale_set_name

str

Required

The name of the VM scale set.

cls

callable

A custom type or function that will be passed the direct response

Returns

RollingUpgradeStatusInfo, or the result of cls(response)

Return type

RollingUpgradeStatusInfo

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.compute.v2020_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\compute\\v2020_12_01\\models\\__init__.py'>