VirtualMachineResource.DeallocateAsync Method

Definition

Namespace:

Azure.ResourceManager.Compute

Assembly:

Azure.ResourceManager.Compute.dll

Package:

Azure.ResourceManager.Compute v1.4.0

Source:

VirtualMachineResource.cs

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate
• Operation Id: VirtualMachines_Deallocate
• Default Api Version: 2023-09-01
• Resource: VirtualMachineResource

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> DeallocateAsync (Azure.WaitUntil waitUntil, bool? hibernate = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeallocateAsync : Azure.WaitUntil * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.DeallocateAsync : Azure.WaitUntil * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>

Public Overridable Function DeallocateAsync (waitUntil As WaitUntil, Optional hibernate 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.

hibernate

Nullable<Boolean>

Optional parameter to hibernate a virtual machine. (Feature in Preview).

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation>