percentile_target

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

Overview

Name	percentile_target
Type	Resource
Id	azure.cosmosdb.percentile_target

Fields

The following fields are returned by SELECT queries:

list_metrics

Name	Datatype	Description
name	object	The name information for the metric.
endTime	string (date-time)	The end time for the metric (ISO-8601 format).
metricValues	array	The percentile metric values for the specified time window and timestep.
startTime	string (date-time)	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. Known values are: "Count", "Bytes", "Seconds", "Percent", "CountPerSecond", "BytesPerSecond", and "Milliseconds". (Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond, Milliseconds)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_metrics	select	resource_group_name, account_name, target_region, subscription_id, $filter		Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data.

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
$filter	string	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.
account_name	string	Cosmos DB database account name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
target_region	string	Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized. Required.

SELECT examples

list_metrics

Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data.

SELECT
name,
endTime,
metricValues,
startTime,
timeGrain,
unit
FROM azure.cosmosdb.percentile_target
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND target_region = '{{ target_region }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}' -- required
;