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 dimensions

dimensions: LocalizableString[]

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

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 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. Possible values include: 'None', 'Average', 'Count', 'Minimum', 'Maximum', 'Total'

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

unit: Unit

the unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'CountPerSecond', 'BytesPerSecond', 'Percent', 'MilliSeconds', 'ByteSeconds', 'Unspecified', 'Cores', 'MilliCores', 'NanoCores', 'BitsPerSecond'

Generated using TypeDoc