PartitionKeyRangeIdRegionOperations.ListMetrics(String, String, String, String, String, String, String, CancellationToken) Method

Definition

Retrieves the metrics determined by the given filter for the given partition key range id and region.

public virtual Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric> ListMetrics (string resourceGroupName, string accountName, string region, string databaseRid, string collectionRid, string partitionKeyRangeId, string filter, System.Threading.CancellationToken cancellationToken = default);
abstract member ListMetrics : string * string * string * string * string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric>
override this.ListMetrics : string * string * string * string * string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric>
Public Overridable Function ListMetrics (resourceGroupName As String, accountName As String, region As String, databaseRid As String, collectionRid As String, partitionKeyRangeId As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PartitionMetric)

Parameters

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.

partitionKeyRangeId
String

Partition Key Range Id for which to get data.

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 to use.

Returns

Pageable<PartitionMetric>

Exceptions

resourceGroupName, accountName, region, databaseRid, collectionRid, partitionKeyRangeId, or filter is null.

Applies to