CollectionPartitionOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosDBManagementClient's

<xref:collection_partition> attribute.

Inheritance

builtins.object

CollectionPartitionOperations

Constructor

CollectionPartitionOperations(*args, **kwargs)

Methods

list_metrics	Retrieves the metrics determined by the given filter for the given collection, split by partition.
list_usages	Retrieves the usages (most recent storage data) for the given collection, split by partition.

list_metrics

Retrieves the metrics determined by the given filter for the given collection, split by partition.

list_metrics(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, filter: str, **kwargs: Any) -> Iterable[PartitionMetric]

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.
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
ItemPaged[PartitionMetric]	An iterator like instance of either PartitionMetric or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_usages

Retrieves the usages (most recent storage data) for the given collection, split by partition.

list_usages(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, filter: str | None = None, **kwargs: Any) -> Iterable[PartitionUsage]

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.
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 usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names). Default value is None.

Returns

Type	Description
ItemPaged[PartitionUsage]	An iterator like instance of either PartitionUsage 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'>