Package version:

Interface MetricDefinition

Metric definition class specifies the metadata for a metric.

interface MetricDefinition {
    category?: string;
    description?: string;
    dimensions?: {};
    id?: string;
    isDimensionRequired?: boolean;
    metricAvailabilities?: {};
    metricClass?: string;
    name?: string;
    namespace?: string;
    primaryAggregationType?: AggregationType;
    resourceId?: string;
    supportedAggregationTypes?: {};
    unit?: string;
}

Properties

category? description? dimensions? id? isDimensionRequired? metricAvailabilities? metricClass? name? namespace? primaryAggregationType? resourceId? supportedAggregationTypes? unit?

Properties

Optionalcategory

category?: string

Custom category name for this metric.

Optionaldescription

description?: string

Detailed description of this metric.

Optionaldimensions

dimensions?: {}

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

Optionalid

id?: string

the resource identifier of the metric definition.

OptionalisDimensionRequired

isDimensionRequired?: boolean

Flag to indicate whether the dimension is required.

OptionalmetricAvailabilities

metricAvailabilities?: {}

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

OptionalmetricClass

metricClass?: string

The class of the metric.

Optionalname

name?: string

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

Optionalnamespace

namespace?: string

the namespace the metric belongs to.

OptionalprimaryAggregationType

primaryAggregationType?: AggregationType

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

OptionalresourceId

resourceId?: string

the resource identifier of the resource that emitted the metric.

OptionalsupportedAggregationTypes

supportedAggregationTypes?: {}

the collection of what aggregation types are supported.

Optionalunit

unit?: string

The unit of the metric.

Settings

Member Visibility