PoolOperations.RemoveFromPoolAsync Method (String, IEnumerable<String>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)

 

Removes the specified compute nodes from the specified pool.

Namespace:   Microsoft.Azure.Batch
Assembly:  Microsoft.Azure.Batch (in Microsoft.Azure.Batch.dll)

Syntax

public Task RemoveFromPoolAsync(
    string poolId,
    IEnumerable<string> computeNodeIds,
    Nullable<ComputeNodeDeallocationOption> deallocationOption = null,
    Nullable<TimeSpan> resizeTimeout = null,
    IEnumerable<BatchClientBehavior> additionalBehaviors = null
)

public:
Task^ RemoveFromPoolAsync(
    String^ poolId,
    IEnumerable<String^>^ computeNodeIds,
    Nullable<ComputeNodeDeallocationOption> deallocationOption = null,
    Nullable<TimeSpan> resizeTimeout = null,
    IEnumerable<BatchClientBehavior^>^ additionalBehaviors = null
)

member RemoveFromPoolAsync : 
        poolId:string *
        computeNodeIds:IEnumerable<string> *
        deallocationOption:Nullable<ComputeNodeDeallocationOption> = null *
        resizeTimeout:Nullable<TimeSpan> = null *
        additionalBehaviors:IEnumerable<BatchClientBehavior> = null -> Task

Public Function RemoveFromPoolAsync (
    poolId As String,
    computeNodeIds As IEnumerable(Of String),
    deallocationOption As Nullable(Of ComputeNodeDeallocationOption),
    resizeTimeout As Nullable(Of TimeSpan),
    additionalBehaviors As IEnumerable(Of BatchClientBehavior)
) As Task

Parameters

• poolId
  Type: System.String

  The id of the pool.

• computeNodeIds
  Type: System.Collections.Generic.IEnumerable<String>

  The ids of the compute nodes to remove from the pool.

• deallocationOption
  Type: System.Nullable<ComputeNodeDeallocationOption>

  Specifies when nodes may be removed from the pool. The default is Requeue.

• resizeTimeout
  Type: System.Nullable<TimeSpan>

  Specifies the timeout for removal of compute nodes from the pool. The default value is 10 minutes. The minimum value is 5 minutes.

• additionalBehaviors
  Type: System.Collections.Generic.IEnumerable<BatchClientBehavior>

  A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.

Return Value

Type: System.Threading.Tasks.Task

A Task that represents the asynchronous operation.

Remarks

You can only remove nodes from a pool when the AllocationState of the pool is Steady. If the pool is already resizing, an exception occurs.

When you remove nodes from a pool, the pool's AllocationState changes from Steady to Resizing.

The remove operation runs asynchronously.

See Also

RemoveFromPoolAsync Overload
PoolOperations Class
Microsoft.Azure.Batch Namespace

Return to top