MetricDefinition interface
Metric definition class specifies the metadata for a metric.
Properties
| category | Custom category name for this metric. |
| description | Detailed description of this metric. |
| dimensions | the name and the display name of the dimension, i.e. it is a localizable string. |
| id | the resource identifier of the metric definition. |
| is |
Flag to indicate whether the dimension is required. |
| metric |
the collection of what aggregation intervals are available to be queried. |
| metric |
The class of the metric. |
| name | the name and the display name of the metric, i.e. it is a localizable string. |
| namespace | the namespace the metric belongs to. |
| primary |
the primary aggregation type value defining how to use the values for display. |
| resource |
the resource identifier of the resource that emitted the metric. |
| supported |
the collection of what aggregation types are supported. |
| unit | The unit of the metric. |
Property Details
category
Custom category name for this metric.
category?: stringProperty Value
string
description
Detailed description of this metric.
description?: stringProperty Value
string
dimensions
the name and the display name of the dimension, i.e. it is a localizable string.
dimensions?: string[]Property Value
string[]
id
the resource identifier of the metric definition.
id?: stringProperty Value
string
isDimensionRequired
Flag to indicate whether the dimension is required.
isDimensionRequired?: booleanProperty Value
boolean
metricAvailabilities
the collection of what aggregation intervals are available to be queried.
metricAvailabilities?: MetricAvailability[]Property Value
metricClass
The class of the metric.
metricClass?: stringProperty Value
string
name
the name and the display name of the metric, i.e. it is a localizable string.
name?: stringProperty Value
string
namespace
the namespace the metric belongs to.
namespace?: stringProperty Value
string
primaryAggregationType
the primary aggregation type value defining how to use the values for display.
primaryAggregationType?: AggregationTypeProperty Value
resourceId
the resource identifier of the resource that emitted the metric.
resourceId?: stringProperty Value
string
supportedAggregationTypes
the collection of what aggregation types are supported.
supportedAggregationTypes?: AggregationType[]Property Value
unit
The unit of the metric.
unit?: stringProperty Value
string
