PoolOperations.DeletePoolAsync 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.
Deletes the specified pool.
public System.Threading.Tasks.Task DeletePoolAsync (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);member this.DeletePoolAsync : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function DeletePoolAsync (poolId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- poolId
- String
The id of the pool to delete.
- additionalBehaviors
- IEnumerable<BatchClientBehavior>
A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.
- cancellationToken
- CancellationToken
A CancellationToken for controlling the lifetime of the asynchronous operation.
Returns
A Task object that represents the asynchronous operation.
Remarks
The delete operation requests that the pool be deleted. The request puts the pool in the Deleting state. The Batch service will requeue any running tasks and perform the actual pool deletion without any further client action.
The delete operation runs asynchronously.
Applies to
Azure SDK for .NET