CosmosDBAccountResource.GetMetricsAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBAccountResource.cs

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-09-01-preview
• Resource: CosmosDBAccountResource

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

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

Public Overridable Function GetMetricsAsync (filter As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(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

AsyncPageable<CosmosDBBaseMetric>

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

Exceptions

ArgumentNullException

filter is null.