MetricDefinition interface

  • Reference
Package:
@azure/arm-monitor-profile-2020-09-01-hybrid

Metric definition class specifies the metadata for a metric.

Properties

category

Custom category name for this metric.
dimensions

the name and the display name of the dimension, i.e. it is a localizable string.
displayDescription

Detailed description of this metric.
id

the resource identifier of the metric definition.
isDimensionRequired

Flag to indicate whether the dimension is required.
metricAvailabilities

the collection of what aggregation intervals are available to be queried.
metricClass

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.
primaryAggregationType

the primary aggregation type value defining how to use the values for display.
resourceId

the resource identifier of the resource that emitted the metric.
supportedAggregationTypes

the collection of what aggregation types are supported.
unit

The unit of the metric.

Property Details

category

Custom category name for this metric.

category?: string

Property Value

string

dimensions

the name and the display name of the dimension, i.e. it is a localizable string.

dimensions?: LocalizableString[]

Property Value

LocalizableString[]

displayDescription

Detailed description of this metric.

displayDescription?: string

Property Value

string

id

the resource identifier of the metric definition.

id?: string

Property Value

string

isDimensionRequired

Flag to indicate whether the dimension is required.

isDimensionRequired?: boolean

Property Value

boolean

metricAvailabilities

the collection of what aggregation intervals are available to be queried.

metricAvailabilities?: MetricAvailability[]

Property Value

MetricAvailability[]

metricClass

The class of the metric.

metricClass?: string

Property Value

string

name

the name and the display name of the metric, i.e. it is a localizable string.

name?: LocalizableString

Property Value

LocalizableString

namespace

the namespace the metric belongs to.

namespace?: string

Property Value

string

primaryAggregationType

the primary aggregation type value defining how to use the values for display.

primaryAggregationType?: AggregationType

Property Value

AggregationType

resourceId

the resource identifier of the resource that emitted the metric.

resourceId?: string

Property Value

string

supportedAggregationTypes

the collection of what aggregation types are supported.

supportedAggregationTypes?: AggregationType[]

Property Value

AggregationType[]

unit

The unit of the metric.

unit?: string

Property Value

string