Delen via


CosmosDBAccountResource.GetMetricsCollectionsAsync Method

Definition

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

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

Parameters

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

Returns

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

Exceptions

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

databaseRid, collectionRid or filter is null.

Applies to