VirtualMachineScaleSetsOperationsExtensions.BeginDeallocateAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Management.Compute
Assembly:
Microsoft.Azure.Management.Compute.dll
Package:
Microsoft.Azure.Management.Compute v61.0.0

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

public static System.Threading.Tasks.Task BeginDeallocateAsync (this Microsoft.Azure.Management.Compute.IVirtualMachineScaleSetsOperations operations, string resourceGroupName, string vmScaleSetName, bool? hibernate = default, System.Collections.Generic.IList<string> instanceIds = default, System.Threading.CancellationToken cancellationToken = default);
static member BeginDeallocateAsync : Microsoft.Azure.Management.Compute.IVirtualMachineScaleSetsOperations * string * string * Nullable<bool> * System.Collections.Generic.IList<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function BeginDeallocateAsync (operations As IVirtualMachineScaleSetsOperations, resourceGroupName As String, vmScaleSetName As String, Optional hibernate As Nullable(Of Boolean) = Nothing, Optional instanceIds As IList(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations
IVirtualMachineScaleSetsOperations

The operations group for this extension method.

resourceGroupName
String

The name of the resource group.

vmScaleSetName
String

The name of the VM scale set.

hibernate
Nullable<Boolean>

Optional parameter to hibernate a virtual machine from the VM scale set. (This feature is available for VMSS with Flexible OrchestrationMode only)

instanceIds
IList<String>

The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task

Applies to