CosmosDBAccountResource.GetMetricsCollectionPartitions Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.3.2

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.8

Source:: CosmosDBAccountResource.cs

Source:: CosmosDBAccountResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Retrieves the metrics determined by the given filter for the given collection, split by partition.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics
Operation Id: CollectionPartition_ListMetrics
Default Api Version: 2024-02-15-preview

public virtual Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric> GetMetricsCollectionPartitions (string databaseRid, string collectionRid, string filter, System.Threading.CancellationToken cancellationToken = default);

abstract member GetMetricsCollectionPartitions : string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric>
override this.GetMetricsCollectionPartitions : string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric>

Public Overridable Function GetMetricsCollectionPartitions (databaseRid As String, collectionRid As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PartitionMetric)

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

Pageable<PartitionMetric>

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

Exceptions

ArgumentException

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

ArgumentNullException

databaseRid, collectionRid or filter is null.

Applies to