CollectionRegionOperationsExtensions.ListMetricsAsync Method

Definition

Namespace:

Microsoft.Azure.Management.CosmosDB

Assembly:

Microsoft.Azure.Management.CosmosDB.dll

Package:

Microsoft.Azure.Management.CosmosDB v3.3.0

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

public static System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.Management.CosmosDB.Models.Metric>> ListMetricsAsync (this Microsoft.Azure.Management.CosmosDB.ICollectionRegionOperations operations, string resourceGroupName, string accountName, string region, string databaseRid, string collectionRid, string filter, System.Threading.CancellationToken cancellationToken = default);

static member ListMetricsAsync : Microsoft.Azure.Management.CosmosDB.ICollectionRegionOperations * string * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Management.CosmosDB.Models.Metric>>

<Extension()>
Public Function ListMetricsAsync (operations As ICollectionRegionOperations, resourceGroupName As String, accountName As String, region As String, databaseRid As String, collectionRid As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of Metric))

Parameters

operations

ICollectionRegionOperations

The operations group for this extension method.

resourceGroupName

String

The name of the resource group. The name is case insensitive.

accountName

String

Cosmos DB database account name.

region

String

Cosmos DB region, with spaces between words and each word capitalized.

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

Task<IEnumerable<Metric>>