MetricSpecification interface

Specifications of the Metrics for Azure Monitoring.

Properties

aggregationType

Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.

category

The name of the metric category that the metric belongs to. A metric can only belong to a single category.

dimensions

The dimensions of the metrics.

displayDescription

Localized friendly description of the metric.

displayName

Localized friendly display name of the metric.

fillGapWithZero

Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. Ex. a metric that returns the number of times a particular error code was emitted. The error code may not appear often, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.

name

Name of the metric.

unit

The unit that makes sense for the metric.

Property Details

aggregationType

Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.

aggregationType?: string

Property Value

string

category

The name of the metric category that the metric belongs to. A metric can only belong to a single category.

category?: string

Property Value

string

dimensions

The dimensions of the metrics.

dimensions?: Dimension[]

Property Value

displayDescription

Localized friendly description of the metric.

displayDescription?: string

Property Value

string

displayName

Localized friendly display name of the metric.

displayName?: string

Property Value

string

fillGapWithZero

Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. Ex. a metric that returns the number of times a particular error code was emitted. The error code may not appear often, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.

fillGapWithZero?: string

Property Value

string

name

Name of the metric.

name?: string

Property Value

string

unit

The unit that makes sense for the metric.

unit?: string

Property Value

string