Dela via


PoolOperations.ListPools Method

Definition

Enumerates the pools in the Batch account.

public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.CloudPool> ListPools (Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.ListPools : Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.CloudPool>
Public Function ListPools (Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As IPagedEnumerable(Of CloudPool)

Parameters

detailLevel
DetailLevel

A DetailLevel used for filtering the list and for controlling which properties are retrieved from the service.

additionalBehaviors
IEnumerable<BatchClientBehavior>

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

Returns

An IPagedEnumerable<T> that can be used to enumerate pools asynchronously or synchronously.

Remarks

This method returns immediately; the pools are retrieved from the Batch service only when the collection is enumerated. Retrieval is non-atomic; pools are retrieved in pages during enumeration of the collection.

Applies to