metrics

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

Overview

Name	metrics
Type	Resource
Id	azure.developer_loadtesting.metrics

Fields

The following fields are returned by SELECT queries:

list_metrics

Name	Datatype	Description
data	array	An array of data points representing the metric values.
dimensionValues	array	The dimension values.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_metrics	select	test_run_id, metricname, metricNamespace, timespan, endpoint	aggregation, interval	List the metric values for a load test run. List the metric values for a load test run.

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
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
metricNamespace	string	Metric namespace to query metric definitions for. Required.
metricname	string	Metric name. Required.
test_run_id	string	Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
timespan	string	The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. Required.
aggregation	string	The aggregation. Default value is None.
interval	string	The interval (i.e. timegrain) of the query. Known values are: "PT5S", "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None.

SELECT examples

list_metrics

List the metric values for a load test run. List the metric values for a load test run.

SELECT
data,
dimensionValues
FROM azure.developer_loadtesting.metrics
WHERE test_run_id = '{{ test_run_id }}' -- required
AND metricname = '{{ metricname }}' -- required
AND metricNamespace = '{{ metricNamespace }}' -- required
AND timespan = '{{ timespan }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND aggregation = '{{ aggregation }}'
AND interval = '{{ interval }}'
;