Share via


CollectionOperationsExtensions.ListMetricsAsync Method

Definition

Retrieves the metrics determined by the given filter for the given database account and collection.

public static System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.Management.CosmosDB.Fluent.Models.Metric>> ListMetricsAsync (this Microsoft.Azure.Management.CosmosDB.Fluent.ICollectionOperations operations, string resourceGroupName, string accountName, string databaseRid, string collectionRid, string filter, System.Threading.CancellationToken cancellationToken = default);
static member ListMetricsAsync : Microsoft.Azure.Management.CosmosDB.Fluent.ICollectionOperations * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Management.CosmosDB.Fluent.Models.Metric>>
<Extension()>
Public Function ListMetricsAsync (operations As ICollectionOperations, resourceGroupName As String, accountName As String, databaseRid As String, collectionRid As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of Metric))

Parameters

operations
ICollectionOperations

The operations group for this extension method.

resourceGroupName
String

Name of an Azure resource group.

accountName
String

Cosmos DB database account name.

databaseRid
String

Cosmos DB database rid.

collectionRid
String

Cosmos DB collection rid.

filter
String

An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

cancellationToken
CancellationToken

The cancellation token.

Returns

Applies to