metric_definitions

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

Overview

Name	metric_definitions
Type	Resource
Id	azure.developer_loadtesting.metric_definitions

Fields

The following fields are returned by SELECT queries:

get_metric_definitions

Name	Datatype	Description
name	string	The metric name.
description	string	The metric description.
dimensions	array	List of dimensions.
metricAvailabilities	array	Metric availability specifies the time grain (aggregation interval or frequency).
namespace	string	The namespace the metric belongs to.
primaryAggregationType	string	The primary aggregation type value defining how to use the values for display. Known values are: "Average", "Count", "None", "Total", "Percentile75", "Percentile90", "Percentile95", "Percentile96", "Percentile97", "Percentile98", "Percentile99", "Percentile999", and "Percentile9999". (Average, Count, None, Total, Percentile75, Percentile90, Percentile95, Percentile96, Percentile97, Percentile98, Percentile99, Percentile999, Percentile9999)
supportedAggregationTypes	array	The collection of what all aggregation types are supported.
unit	string	The unit of the metric. Known values are: "NotSpecified", "Percent", "Count", "Seconds", "Milliseconds", "Bytes", "BytesPerSecond", and "CountPerSecond". (NotSpecified, Percent, Count, Seconds, Milliseconds, Bytes, BytesPerSecond, CountPerSecond)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_metric_definitions	select	test_run_id, metricNamespace, endpoint		List the metric definitions for a load test run. List the metric definitions 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.
test_run_id	string	Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.

SELECT examples

get_metric_definitions

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

SELECT
name,
description,
dimensions,
metricAvailabilities,
namespace,
primaryAggregationType,
supportedAggregationTypes,
unit
FROM azure.developer_loadtesting.metric_definitions
WHERE test_run_id = '{{ test_run_id }}' -- required
AND metricNamespace = '{{ metricNamespace }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;