IVirtualMachineScaleSetsOperations.BeginDeallocateWithHttpMessagesAsync Method

Definition

Overloads

BeginDeallocateWithHttpMessagesAsync(String, String, IList<String>, Dictionary<String,List<String>>, CancellationToken)

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.

BeginDeallocateWithHttpMessagesAsync(String, String, Nullable<Boolean>, IList<String>, Dictionary<String,List<String>>, CancellationToken)

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.

BeginDeallocateWithHttpMessagesAsync(String, String, IList<String>, Dictionary<String,List<String>>, CancellationToken)

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 System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> BeginDeallocateWithHttpMessagesAsync (string resourceGroupName, string vmScaleSetName, System.Collections.Generic.IList<string> instanceIds, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member BeginDeallocateWithHttpMessagesAsync : string * string * System.Collections.Generic.IList<string> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
Public Function BeginDeallocateWithHttpMessagesAsync (resourceGroupName As String, vmScaleSetName As String, instanceIds As IList(Of String), Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName
String

The name of the resource group.

vmScaleSetName
String

The name of the VM scale set.

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.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to

BeginDeallocateWithHttpMessagesAsync(String, String, Nullable<Boolean>, IList<String>, Dictionary<String,List<String>>, CancellationToken)

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 System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> BeginDeallocateWithHttpMessagesAsync (string resourceGroupName, string vmScaleSetName, bool? hibernate = default, System.Collections.Generic.IList<string> instanceIds = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member BeginDeallocateWithHttpMessagesAsync : string * string * Nullable<bool> * System.Collections.Generic.IList<string> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
Public Function BeginDeallocateWithHttpMessagesAsync (resourceGroupName As String, vmScaleSetName As String, Optional hibernate As Nullable(Of Boolean) = Nothing, Optional instanceIds As IList(Of String) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

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.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to