VirtualMachineScaleSetVmResource.PowerOffAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
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.
