CosmosDBAccountResource.GetMetricsCollectionRegionsAsync 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 database account, collection and region.

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

public virtual Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseMetric> GetMetricsCollectionRegionsAsync (string region, string databaseRid, string collectionRid, string filter, System.Threading.CancellationToken cancellationToken = default);

abstract member GetMetricsCollectionRegionsAsync : string * string * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseMetric>
override this.GetMetricsCollectionRegionsAsync : string * string * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseMetric>

Public Overridable Function GetMetricsCollectionRegionsAsync (region As String, databaseRid As String, collectionRid As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of CosmosDBBaseMetric)

Parameters

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

Returns

AsyncPageable<CosmosDBBaseMetric>

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

Exceptions

ArgumentException

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

ArgumentNullException

region, databaseRid, collectionRid or filter is null.

Applies to