LogAnalyticsSignal interface

Package:

@azure/arm-cloudhealth

A Log Analytics Query signal instance assigned to an entity.

Extends

SignalInstanceProperties

Properties

dataUnit	Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count))
displayName	Display name
evaluationRules	Evaluation rules for the signal definition
queryText	Query text in KQL syntax
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. If not specified, the KQL query must define a time range.
valueColumnName	Name of the column in the result set to evaluate against the thresholds. Defaults to the first column in the result set if not specified. The column must be numeric.

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

dataUnit

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

dataUnit?: string

Property Value

string

displayName

Display name

displayName?: string

Property Value

string

evaluationRules

Evaluation rules for the signal definition

evaluationRules?: EvaluationRule

Property Value

EvaluationRule

queryText

Query text in KQL syntax

queryText?: 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: "LogAnalyticsQuery"

Property Value

"LogAnalyticsQuery"

timeGrain

Time range of signal. ISO duration format like PT10M. If not specified, the KQL query must define a time range.

timeGrain?: string

Property Value

string

valueColumnName

Name of the column in the result set to evaluate against the thresholds. Defaults to the first column in the result set if not specified. The column must be numeric.

valueColumnName?: 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