CosmosDBAccountResource.GetMetrics(String, CancellationToken) 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.9

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.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics
Operation Id: DatabaseAccounts_ListMetrics
Default Api Version: 2024-02-15-preview
Resource: CosmosDBAccountResource

public virtual Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseMetric> GetMetrics (string filter, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetMetrics (filter As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of CosmosDBBaseMetric)

Parameters

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

filter is null.

Applies to

Share via