Share via

PercentileSourceTargetOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosDBManagementClient's

<xref:percentile_source_target> attribute.

Inheritance
builtins.object
PercentileSourceTargetOperations

Constructor

PercentileSourceTargetOperations(*args, **kwargs)

Methods

list_metrics

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.

list_metrics

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.

list_metrics(resource_group_name: str, account_name: str, source_region: str, target_region: str, filter: str, **kwargs: Any) -> AsyncIterable[PercentileMetric]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

Cosmos DB database account name. Required.
source_region
Required
str

Source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized. Required.
target_region
Required
str

Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized. Required.
filter
Required
str

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. Required.

Returns

Type Description
AsyncItemPaged[PercentileMetric]

An iterator like instance of either PercentileMetric or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>