collection_metric_definitions

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

Overview

Name	collection_metric_definitions
Type	Resource
Id	azure.cosmos_db.collection_metric_definitions

Fields

The following fields are returned by SELECT queries:

list

The metric definitions for the collection were retrieved successfully.

Name	Datatype	Description
name	object	The name information for the metric.
metricAvailabilities	array	The list of metric availabilities for the account.
primaryAggregationType	string	The primary aggregation type of the metric.
resourceUri	string	The resource uri of the database.
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		Retrieves metric definitions for the given collection.

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.

SELECT examples

list

Retrieves metric definitions for the given collection.

SELECT
name,
metricAvailabilities,
primaryAggregationType,
resourceUri,
unit
FROM azure.cosmos_db.collection_metric_definitions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND databaseRid = '{{ databaseRid }}' -- required
AND collectionRid = '{{ collectionRid }}' -- required
;