IPoolOperations.ListUsageMetricsWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.3.1

Source:: IPoolOperations.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Batch.Protocol.Models.PoolUsageMetrics>,Microsoft.Azure.Batch.Protocol.Models.PoolListUsageMetricsHeaders>> ListUsageMetricsWithHttpMessagesAsync (Microsoft.Azure.Batch.Protocol.Models.PoolListUsageMetricsOptions poolListUsageMetricsOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ListUsageMetricsWithHttpMessagesAsync : Microsoft.Azure.Batch.Protocol.Models.PoolListUsageMetricsOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Batch.Protocol.Models.PoolUsageMetrics>, Microsoft.Azure.Batch.Protocol.Models.PoolListUsageMetricsHeaders>>

Public Function ListUsageMetricsWithHttpMessagesAsync (Optional poolListUsageMetricsOptions As PoolListUsageMetricsOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of PoolUsageMetrics), PoolListUsageMetricsHeaders))

Parameters

poolListUsageMetricsOptions: PoolListUsageMetricsOptions

Additional parameters for the operation

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<PoolUsageMetrics>,PoolListUsageMetricsHeaders>>

Exceptions

BatchErrorException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

Remarks

If you do not specify a $filter clause including a poolId, the response includes all Pools that existed in the Account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.

Applies to

Share via