Share via

PoolOperations.DeletePool Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Batch
Assembly:
Microsoft.Azure.Batch.dll
Package:
Microsoft.Azure.Batch v16.3.1
Source:
PoolOperations.cs

Deletes the specified pool.

public void DeletePool (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.DeletePool : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit
Public Sub DeletePool (poolId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)

Parameters

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.

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.

Applies to