Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricDefinition

Package version

Metric definition class specifies the metadata for a metric.

Hierarchy

  • MetricDefinition

Index

Properties

Optional category

category: undefined | string

Custom category name for this metric.

Optional dimensions

dimensions: LocalizableString[]

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

Optional displayDescription

displayDescription: undefined | string

Detailed description of this metric.

Optional id

id: undefined | string

the resource identifier of the metric definition.

Optional isDimensionRequired

isDimensionRequired: undefined | false | true

Flag to indicate whether the dimension is required.

Optional metricAvailabilities

metricAvailabilities: MetricAvailability[]

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

Optional metricClass

metricClass: MetricClass

The class of the metric.

Optional name

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

Optional namespace

namespace: undefined | string

the namespace the metric belongs to.

Optional primaryAggregationType

primaryAggregationType: AggregationType

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

Optional resourceId

resourceId: undefined | string

the resource identifier of the resource that emitted the metric.

Optional supportedAggregationTypes

supportedAggregationTypes: AggregationType[]

the collection of what aggregation types are supported.

Optional unit

The unit of the metric.

Generated using TypeDoc