IPoolOperations.RemoveNodesWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.3.1

Source:: IPoolOperations.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Removes Compute Nodes from the specified Pool.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.PoolRemoveNodesHeaders>> RemoveNodesWithHttpMessagesAsync (string poolId, Microsoft.Azure.Batch.Protocol.Models.NodeRemoveParameter nodeRemoveParameter, Microsoft.Azure.Batch.Protocol.Models.PoolRemoveNodesOptions poolRemoveNodesOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member RemoveNodesWithHttpMessagesAsync : string * Microsoft.Azure.Batch.Protocol.Models.NodeRemoveParameter * Microsoft.Azure.Batch.Protocol.Models.PoolRemoveNodesOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.PoolRemoveNodesHeaders>>

Public Function RemoveNodesWithHttpMessagesAsync (poolId As String, nodeRemoveParameter As NodeRemoveParameter, Optional poolRemoveNodesOptions As PoolRemoveNodesOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of PoolRemoveNodesHeaders))

Parameters

poolId: String

The ID of the Pool from which you want to remove Compute Nodes.

nodeRemoveParameter: NodeRemoveParameter

The parameters for the request.

poolRemoveNodesOptions: PoolRemoveNodesOptions

Additional parameters for the operation

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationHeaderResponse<PoolRemoveNodesHeaders>>

Exceptions

BatchErrorException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null

Remarks

This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing. Each request may remove up to 100 nodes.

Applies to

Share via