metric_definitions
Creates, updates, deletes, gets or lists a metric_definitions
resource.
Overview
Name | metric_definitions |
Type | Resource |
Id | azure.monitor.metric_definitions |
Fields
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 aggregation type of the metric. |
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
Name | Accessible by | Required Params | Description |
---|---|---|---|
list | SELECT | resourceUri | Lists the metric definitions for the resource. |
SELECT
examples
Lists the metric definitions for the resource.
SELECT
id,
name,
category,
dimensions,
displayDescription,
isDimensionRequired,
metricAvailabilities,
metricClass,
namespace,
primaryAggregationType,
resourceId,
supportedAggregationTypes,
unit
FROM azure.monitor.metric_definitions
WHERE resourceUri = '{{ resourceUri }}';