IVirtualMachineScaleSetsOperations.BeginDeleteInstancesWithHttpMessagesAsync Method

Definition

Deletes virtual machines in a VM scale set.

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

instanceIds
IList<String>

The virtual machine scale set instance ids.

forceDeletion
Nullable<Boolean>

Optional parameter to force delete virtual machines from the VM scale set. (Feature in Preview)

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