Share via

CollectionRegionOperations Class

  • Reference

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) -> AsyncIterable[Metric]

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

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

Cosmos DB database rid. Required.
collection_rid
Required
str

Cosmos DB collection rid. 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[Metric]

An iterator like instance of either Metric 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'>