CollectionRegionOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosDBManagementClient's

<xref:collection_region> attribute.

Inheritance

builtins.object

CollectionRegionOperations

Constructor

CollectionRegionOperations(*args, **kwargs)

Methods

list_metrics

Retrieves the metrics determined by the given filter for the given database account, collection and region.

list_metrics

Retrieves the metrics determined by the given filter for the given database account, collection and region.

list_metrics(resource_group_name: str, account_name: str, region: str, database_rid: str, collection_rid: str, filter: str, **kwargs: Any) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.MetricListResult]

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.

region

str

Required

Cosmos DB region, with spaces between words and each word capitalized.

database_rid

str

Required

Cosmos DB database rid.

collection_rid

str

Required

Cosmos DB collection rid.

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 MetricListResult or the result of cls(response)

Return type

ItemPaged[MetricListResult]

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'>