VirtualMachineScaleSetVmResource.PowerOffAsync 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:
VirtualMachineScaleSetVmResource.cs.cs
Source:
VirtualMachineScaleSetVmResource.cs.cs

Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff
  • Operation Id: VirtualMachineScaleSetVMs_PowerOff
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> PowerOffAsync (Azure.WaitUntil waitUntil, bool? skipShutdown = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PowerOffAsync : Azure.WaitUntil * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.PowerOffAsync : Azure.WaitUntil * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
Public Overridable Function PowerOffAsync (waitUntil As WaitUntil, Optional skipShutdown As Nullable(Of Boolean) = Nothing, 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.

skipShutdown
Nullable<Boolean>

The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation>

Applies to