AzureResourceSignal interface

Package:

@azure/arm-cloudhealth

An Azure Resource Metric signal instance assigned to an entity.

Extends

SignalInstanceProperties

Properties

aggregationType	Type of aggregation to apply to the metric
dataUnit	Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count))
dimension	Optional: Dimension to split by
dimensionFilter	Optional: Dimension filter to apply to the dimension. Must only be set if also Dimension is set.
displayName	Display name
evaluationRules	Evaluation rules for the signal definition
metricName	Name of the metric
metricNamespace	Metric namespace
refreshInterval	Interval in which the signal is being evaluated. Defaults to PT1M (1 minute).
signalKind	Kind of the signal instance
timeGrain	Time range of signal. ISO duration format like PT10M.

Inherited Properties

name	Unique name of the signal within the entity.
signalDefinitionName	Optional reference to a signal definition that provides default values.
status	Current status of the signal.

Property Details

aggregationType

Type of aggregation to apply to the metric

aggregationType?: string

Property Value

string

dataUnit

Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count))

dataUnit?: string

Property Value

string

dimension

Optional: Dimension to split by

dimension?: string

Property Value

string

dimensionFilter

Optional: Dimension filter to apply to the dimension. Must only be set if also Dimension is set.

dimensionFilter?: string

Property Value

string

displayName

Display name

displayName?: string

Property Value

string

evaluationRules

Evaluation rules for the signal definition

evaluationRules?: EvaluationRule

Property Value

EvaluationRule

metricName

Name of the metric

metricName?: string

Property Value

string

metricNamespace

Metric namespace

metricNamespace?: string

Property Value

string

refreshInterval

Interval in which the signal is being evaluated. Defaults to PT1M (1 minute).

refreshInterval?: string

Property Value

string

signalKind

Kind of the signal instance

signalKind: "AzureResourceMetric"

Property Value

"AzureResourceMetric"

timeGrain

Time range of signal. ISO duration format like PT10M.

timeGrain?: string

Property Value

string

Inherited Property Details

name

Unique name of the signal within the entity.

name: string

Property Value

string

Inherited From SignalInstanceProperties.name

signalDefinitionName

Optional reference to a signal definition that provides default values.

signalDefinitionName?: string

Property Value

string

Inherited From SignalInstanceProperties.signalDefinitionName

status

Current status of the signal.

status?: SignalStatus

Property Value

SignalStatus

Inherited From SignalInstanceProperties.status