IAgentPoolsOperations.DeleteMachinesWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.ContainerService

Assembly:

Microsoft.Azure.PowerShell.Aks.Management.Sdk.dll

Deletes specific machines in an agent pool.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Management.ContainerService.Models.AgentPoolsDeleteMachinesHeaders>> DeleteMachinesWithHttpMessagesAsync(string resourceGroupName, string resourceName, string agentPoolName, System.Collections.Generic.IList<string> machineNames, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteMachinesWithHttpMessagesAsync : string * 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.AzureOperationHeaderResponse<Microsoft.Azure.Management.ContainerService.Models.AgentPoolsDeleteMachinesHeaders>>

Public Function DeleteMachinesWithHttpMessagesAsync (resourceGroupName As String, resourceName As String, agentPoolName As String, machineNames As IList(Of String), Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of AgentPoolsDeleteMachinesHeaders))

Parameters

resourceGroupName

String

The name of the resource group. The name is case insensitive.

resourceName

String

The name of the managed cluster resource.

agentPoolName

String

The name of the agent pool.

machineNames

IList<String>

The agent pool machine names.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationHeaderResponse<AgentPoolsDeleteMachinesHeaders>>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

Remarks

Deletes specific machines in an agent pool.