PoolOperationsExtensions.RemoveNodesAsync Method
Definition
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 static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.PoolRemoveNodesHeaders> RemoveNodesAsync(this Microsoft.Azure.Batch.Protocol.IPoolOperations operations, string poolId, Microsoft.Azure.Batch.Protocol.Models.NodeRemoveParameter nodeRemoveParameter, Microsoft.Azure.Batch.Protocol.Models.PoolRemoveNodesOptions poolRemoveNodesOptions = default, System.Threading.CancellationToken cancellationToken = default);static member RemoveNodesAsync : Microsoft.Azure.Batch.Protocol.IPoolOperations * string * Microsoft.Azure.Batch.Protocol.Models.NodeRemoveParameter * Microsoft.Azure.Batch.Protocol.Models.PoolRemoveNodesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.PoolRemoveNodesHeaders><Extension()>
Public Function RemoveNodesAsync (operations As IPoolOperations, poolId As String, nodeRemoveParameter As NodeRemoveParameter, Optional poolRemoveNodesOptions As PoolRemoveNodesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PoolRemoveNodesHeaders)Parameters
- operations
- IPoolOperations
The operations group for this extension method.
- 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
- cancellationToken
- CancellationToken
The cancellation token.
Returns
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.
