PoolOperations.DeletePoolAsync Method (String, IEnumerable<BatchClientBehavior>)

Deletes the specified pool.

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

Syntax

public Task DeletePoolAsync(
    string poolId,
    IEnumerable<BatchClientBehavior> additionalBehaviors = null
)

public:
Task^ DeletePoolAsync(
    String^ poolId,
    IEnumerable<BatchClientBehavior^>^ additionalBehaviors = null
)

member DeletePoolAsync : 
        poolId:string *
        additionalBehaviors:IEnumerable<BatchClientBehavior> = null -> Task

Public Function DeletePoolAsync (
    poolId As String,
    additionalBehaviors As IEnumerable(Of BatchClientBehavior)
) As Task

Parameters

• poolId
  Type: System.String

  The id of the pool to delete.

• 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 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.

See Also

PoolOperations Class
Microsoft.Azure.Batch Namespace

Return to top