CosmosDBAccountResource.GetMetricsPercentileSourceTargets Method
Definition
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 account, source and target region. This url is only for PBS and Replication Latency data
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics
- Operation Id: PercentileSourceTarget_ListMetrics
- Default Api Version: 2024-05-15-preview
public virtual Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBPercentileMetric> GetMetricsPercentileSourceTargets (string sourceRegion, string targetRegion, string filter, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMetricsPercentileSourceTargets : string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBPercentileMetric>
override this.GetMetricsPercentileSourceTargets : string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBPercentileMetric>
Public Overridable Function GetMetricsPercentileSourceTargets (sourceRegion As String, targetRegion As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of CosmosDBPercentileMetric)
Parameters
- sourceRegion
- String
Source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized.
- 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
A collection of CosmosDBPercentileMetric that may take multiple service requests to iterate over.
Exceptions
sourceRegion
or targetRegion
is an empty string, and was expected to be non-empty.
sourceRegion
, targetRegion
or filter
is null.
Applies to
Azure SDK for .NET