CloudPool.ListComputeNodes Method

Definition

Enumerates the compute nodes of this pool.

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

Parameters

detailLevel
DetailLevel

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

additionalBehaviors
System.Collections.Generic.IEnumerable<BatchClientBehavior>

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

Returns

IPagedEnumerable<ComputeNode>

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

Remarks

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

Applies to