PercentileSourceTargetOperations Class

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) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.PercentileMetricListResult]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

account_name

str

Required

Cosmos DB database account name.

source_region

str

Required

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

target_region

str

Required

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

filter

str

Required

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PercentileMetricListResult]

Exceptions

HttpResponseError

Attributes

models

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