CosmosDBAccountResource.GetMetricsDatabaseAccountRegions Method

Definition

Namespace:
Azure.ResourceManager.CosmosDB
Assembly:
Azure.ResourceManager.CosmosDB.dll
Package:
Azure.ResourceManager.CosmosDB v1.5.0
Package:
Azure.ResourceManager.CosmosDB v1.4.0-beta.13
Source:
CosmosDBAccountResource.cs
Source:
CosmosDBAccountResource.cs

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

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics.
  • Operation Id. : DatabaseAccounts_DatabaseAccountRegionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource. 
public virtual Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseMetric> GetMetricsDatabaseAccountRegions(string region, string filter, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMetricsDatabaseAccountRegions : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseMetric>
override this.GetMetricsDatabaseAccountRegions : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseMetric>
Public Overridable Function GetMetricsDatabaseAccountRegions (region As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of CosmosDBBaseMetric)

Parameters

region
String

Cosmos DB region, with spaces between words and each word capitalized.

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<CosmosDBBaseMetric>

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

Exceptions

ArgumentNullException

region or filter is null.

ArgumentException

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

Applies to