Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricDefinition

Package version

Metric definition class specifies the metadata for a metric. Metric definition class specifies the metadata for a metric. Metric definition.

Hierarchy

  • MetricDefinition

Index

Properties

Optional category

category: undefined | string

Custom category name for this metric. Custom category name for this metric. Custom category name for this metric.

Optional dimensions

dimensions: string[]

the name and the display name of the dimension, i.e. it is a localizable string. the name of the dimension 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. Detailed description of this metric. Detailed description of this metric.

Optional id

id: undefined | string

the resource identifier of the metric definition. the resource identifier of the metric definition. the resource identifier of the metric definition.

Optional isDimensionRequired

isDimensionRequired: undefined | false | true

Flag to indicate whether the dimension is required. Flag to indicate whether the dimension is required. Flag to indicate whether the dimension is required.

Optional metricAvailabilities

metricAvailabilities: MetricAvailability[]

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

Optional metricClass

metricClass: MetricClass

The class of the metric. The class of the metric.

Optional name

name: undefined | string

the name and the display name of the metric, i.e. it is a localizable string. the name of the metric 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. the namespace the metric belongs to.

Optional primaryAggregationType

primaryAggregationType: AggregationType

the primary aggregation type value defining how to use the values for display. the primary aggregation type value defining how to use the values for display. 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. the resource identifier of the resource that emitted the metric. the resource identifier of the resource that emitted the metric.

Optional supportedAggregationTypes

supportedAggregationTypes: AggregationType[]

the collection of what aggregation types are supported. the collection of what aggregation types are supported.

Optional unit

The unit of the metric. the unit of the metric. The unit of the metric.

Generated using TypeDoc