metric_definitions_at_subscription_scopes

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

Overview

Name	metric_definitions_at_subscription_scopes
Type	Resource
Id	azure.monitor.metric_definitions_at_subscription_scopes

Fields

The following fields are returned by SELECT queries:

list

Successful request to get the list of metric definitions

Name	Datatype	Description
id	string	The resource identifier of the metric definition.
name	object	The localizable string class.
category	string	Custom category name for this metric.
dimensions	array	The name and the display name of the dimension, i.e. it is a localizable string.
displayDescription	string	Detailed description of this metric.
isDimensionRequired	boolean	Flag to indicate whether the dimension is required.
metricAvailabilities	array	The collection of what aggregation intervals are available to be queried.
metricClass	string	The class of the metric.
namespace	string	The namespace the metric belongs to.
primaryAggregationType	string	The primary aggregation type value defining how to use the values for display.
resourceId	string	The resource identifier of the resource that emitted the metric.
supportedAggregationTypes	array	The collection of what aggregation types are supported.
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, region	metricnamespace	Lists the metric definitions for the subscription.

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
region	string	The region where the metrics you want reside.
subscriptionId	string	The ID of the target subscription.
metricnamespace	string	Metric namespace to query metric definitions for.

SELECT examples

list

Lists the metric definitions for the subscription.

SELECT
id,
name,
category,
dimensions,
displayDescription,
isDimensionRequired,
metricAvailabilities,
metricClass,
namespace,
primaryAggregationType,
resourceId,
supportedAggregationTypes,
unit
FROM azure.monitor.metric_definitions_at_subscription_scopes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND region = '{{ region }}' -- required
AND metricnamespace = '{{ metricnamespace }}'
;