PoolOperations.ListPoolUsageMetrics(Nullable<DateTime>, Nullable<DateTime>, DetailLevel, IEnumerable<BatchClientBehavior>) Method

Definition

Enumerates pool usage metrics.

public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.PoolUsageMetrics> ListPoolUsageMetrics (Nullable<DateTime> startTime = default, Nullable<DateTime> endTime = default, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.ListPoolUsageMetrics : Nullable<DateTime> * Nullable<DateTime> * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.PoolUsageMetrics>

Parameters

startTime
Nullable<DateTime>

The start time of the aggregation interval covered by this entry.

endTime
Nullable<DateTime>

The end time of the aggregation interval for this entry.

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 metrics asynchronously or synchronously.

Remarks

This method returns immediately; the metrics data is retrieved from the Batch service only when the collection is enumerated.

        Retrieval is non-atomic; metrics data is retrieved in pages during enumeration of the collection.

Applies to