CloudPool.RemoveFromPool 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.
Overloads
| RemoveFromPool(IEnumerable<String>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>) |
Removes the specified compute nodes from this pool. |
| RemoveFromPool(String, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>) |
Removes the specified compute node from this pool. |
| RemoveFromPool(ComputeNode, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>) |
Removes the specified compute node from this pool. |
| RemoveFromPool(IEnumerable<ComputeNode>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>) |
Removes the specified compute nodes from this pool. |
RemoveFromPool(IEnumerable<String>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)
- Source:
- CloudPool.cs
Removes the specified compute nodes from this pool.
public void RemoveFromPool (System.Collections.Generic.IEnumerable<string> computeNodeIds, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);member this.RemoveFromPool : seq<string> * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unitPublic Sub RemoveFromPool (computeNodeIds As IEnumerable(Of String), Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)Parameters
- computeNodeIds
- IEnumerable<String>
The ids of the compute nodes to remove from the pool.
- deallocationOption
- Nullable<ComputeNodeDeallocationOption>
Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is Requeue.
Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.
- additionalBehaviors
- IEnumerable<BatchClientBehavior>
A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.
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.
This is a blocking operation. For a non-blocking equivalent, see RemoveFromPoolAsync(IEnumerable<String>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken).
Applies to
RemoveFromPool(String, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)
- Source:
- CloudPool.cs
Removes the specified compute node from this pool.
public void RemoveFromPool (string computeNodeId, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);member this.RemoveFromPool : string * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unitPublic Sub RemoveFromPool (computeNodeId As String, Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)Parameters
- computeNodeId
- String
The id of the compute node to remove from the pool.
- deallocationOption
- Nullable<ComputeNodeDeallocationOption>
Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is Requeue.
Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.
- additionalBehaviors
- IEnumerable<BatchClientBehavior>
A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.
Remarks
If you need to remove multiple compute nodes from a pool, it is more efficient to use the RemoveFromPool(IEnumerable<String>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>) overload.
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.
This is a blocking operation. For a non-blocking equivalent, see RemoveFromPoolAsync(String, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken).
Applies to
RemoveFromPool(ComputeNode, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)
- Source:
- CloudPool.cs
Removes the specified compute node from this pool.
public void RemoveFromPool (Microsoft.Azure.Batch.ComputeNode computeNode, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);member this.RemoveFromPool : Microsoft.Azure.Batch.ComputeNode * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unitPublic Sub RemoveFromPool (computeNode As ComputeNode, Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)Parameters
- computeNode
- ComputeNode
The ComputeNode to remove from the pool.
- deallocationOption
- Nullable<ComputeNodeDeallocationOption>
Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is Requeue.
Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.
- additionalBehaviors
- IEnumerable<BatchClientBehavior>
A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.
Remarks
If you need to remove multiple compute nodes from a pool, it is more efficient to use the RemoveFromPool(IEnumerable<ComputeNode>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>) overload.
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.
This is a blocking operation. For a non-blocking equivalent, see RemoveFromPoolAsync(ComputeNode, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken).
Applies to
RemoveFromPool(IEnumerable<ComputeNode>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)
- Source:
- CloudPool.cs
Removes the specified compute nodes from this pool.
public void RemoveFromPool (System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.ComputeNode> computeNodes, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);member this.RemoveFromPool : seq<Microsoft.Azure.Batch.ComputeNode> * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unitPublic Sub RemoveFromPool (computeNodes As IEnumerable(Of ComputeNode), Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)Parameters
- computeNodes
- IEnumerable<ComputeNode>
The compute nodes to remove from the pool.
- deallocationOption
- Nullable<ComputeNodeDeallocationOption>
Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is Requeue.
Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.
- additionalBehaviors
- IEnumerable<BatchClientBehavior>
A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.
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.
This is a blocking operation. For a non-blocking equivalent, see RemoveFromPoolAsync(IEnumerable<ComputeNode>, Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken).
