collection_partition_region_metrics

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

Overview

Name	collection_partition_region_metrics
Type	Resource
Id	azure.cosmos_db.collection_partition_region_metrics

Fields

Name	Datatype	Description
name	object	A metric name.
endTime	string	The end time for the metric (ISO-8601 format).
metricValues	array	The metric values for the specified time window and timestep.
partitionId	string	The partition id (GUID identifier) of the metric values.
partitionKeyRangeId	string	The partition key range id (integer identifier) of the metric values.
startTime	string	The start time for the metric (ISO-8601 format).
timeGrain	string	The time grain to be used to summarize the metric values.
unit	string	The unit of the metric.

Methods

Name	Accessible by	Required Params	Description
list	SELECT	$filter, accountName, collectionRid, databaseRid, region, resourceGroupName, subscriptionId	Retrieves the metrics determined by the given filter for the given collection and region, split by partition.

SELECT examples

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

SELECT
name,
endTime,
metricValues,
partitionId,
partitionKeyRangeId,
startTime,
timeGrain,
unit
FROM azure.cosmos_db.collection_partition_region_metrics
WHERE $filter = '{{ $filter }}'
AND accountName = '{{ accountName }}'
AND collectionRid = '{{ collectionRid }}'
AND databaseRid = '{{ databaseRid }}'
AND region = '{{ region }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';