VirtualMachineScaleSetResource.StartOSUpgradeAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Compute
Assembly:
Azure.ResourceManager.Compute.dll
Package:
Azure.ResourceManager.Compute v1.6.0
Package:
Azure.ResourceManager.Compute v1.7.0-beta.1
Source:
VirtualMachineScaleSetResource.cs
Source:
VirtualMachineScaleSetResource.cs

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade
  • Operation Id: VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetRollingUpgradeResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> StartOSUpgradeAsync (Azure.WaitUntil waitUntil, System.Threading.CancellationToken cancellationToken = default);
abstract member StartOSUpgradeAsync : Azure.WaitUntil * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.StartOSUpgradeAsync : Azure.WaitUntil * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
Public Overridable Function StartOSUpgradeAsync (waitUntil As WaitUntil, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation>

Applies to