Sdílet prostřednictvím


CosmosDBAccountResource.GetMetricsPartitionKeyRangeIdsAsync Method

Definition

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
  • Operation Id: PartitionKeyRangeId_ListMetrics
  • Default Api Version: 2024-05-15-preview
public virtual Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric> GetMetricsPartitionKeyRangeIdsAsync (string databaseRid, string collectionRid, string partitionKeyRangeId, string filter, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMetricsPartitionKeyRangeIdsAsync : string * string * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric>
override this.GetMetricsPartitionKeyRangeIdsAsync : string * string * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric>
Public Overridable Function GetMetricsPartitionKeyRangeIdsAsync (databaseRid As String, collectionRid As String, partitionKeyRangeId As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of PartitionMetric)

Parameters

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

An async collection of PartitionMetric that may take multiple service requests to iterate over.

Exceptions

databaseRid, collectionRid or partitionKeyRangeId is an empty string, and was expected to be non-empty.

databaseRid, collectionRid, partitionKeyRangeId or filter is null.

Applies to