CosmosDBAccountResource.GetMetricsPercentileTargetsAsync 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 account target region. This url is only for PBS and Replication Latency data

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics
• Operation Id: PercentileTarget_ListMetrics
• Default Api Version: 2024-09-01-preview

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

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

Public Overridable Function GetMetricsPercentileTargetsAsync (targetRegion As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of CosmosDBPercentileMetric)

Parameters

targetRegion

String

Target region to which data is written. 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

AsyncPageable<CosmosDBPercentileMetric>

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

Exceptions

ArgumentException

targetRegion is an empty string, and was expected to be non-empty.

ArgumentNullException

targetRegion or filter is null.