Share via


VirtualMachineScaleSetResource.PerformMaintenance Method

Definition

Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance
  • Operation Id: VirtualMachineScaleSets_PerformMaintenance
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
public virtual Azure.ResourceManager.ArmOperation PerformMaintenance (Azure.WaitUntil waitUntil, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds vmInstanceIds = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PerformMaintenance : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
override this.PerformMaintenance : Azure.WaitUntil * Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetVmInstanceIds * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
Public Overridable Function PerformMaintenance (waitUntil As WaitUntil, Optional vmInstanceIds As VirtualMachineScaleSetVmInstanceIds = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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.

vmInstanceIds
VirtualMachineScaleSetVmInstanceIds

A list of virtual machine instance IDs from the VM scale set.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Applies to