collection_partition_usages

Creates, updates, deletes, gets or lists a collection_partition_usages resource.

Overview

Name	collection_partition_usages
Type	Resource
Id	azure.cosmos_db.collection_partition_usages

Fields

The following fields are returned by SELECT queries:

list

The usages for the collection, per partition were retrieved successfully.

Name	Datatype	Description
name	object	The name information for the metric.
currentValue	integer (int64)	Current value for this metric
limit	integer (int64)	Maximum value for this metric
partitionId	string	The partition id (GUID identifier) of the usages.
partitionKeyRangeId	string	The partition key range id (integer identifier) of the usages.
quotaPeriod	string	The quota period used to summarize the usage values.
unit	string	The unit of the metric.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	subscriptionId, resourceGroupName, accountName, databaseRid, collectionRid	$filter	Retrieves the usages (most recent storage data) for the given collection, split by partition.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	Cosmos DB database account name.
collectionRid	string	Cosmos DB collection rid.
databaseRid	string	Cosmos DB database rid.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$filter	string	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).

SELECT examples

list

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

SELECT
name,
currentValue,
limit,
partitionId,
partitionKeyRangeId,
quotaPeriod,
unit
FROM azure.cosmos_db.collection_partition_usages
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND databaseRid = '{{ databaseRid }}' -- required
AND collectionRid = '{{ collectionRid }}' -- required
AND $filter = '{{ $filter }}'
;