Essentials interface

Package:

@azure/arm-alertsmanagement

This object contains consistent fields across different monitor services.

Properties

actionStatus	Action status
alertRule	Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule.
alertState	Alert object state, which can be modified by the user.
description	Alert description.
lastModifiedDateTime	Last modification time(ISO-8601 format) of alert instance.
lastModifiedUserName	User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user.
monitorCondition	Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds.
monitorConditionResolvedDateTime	Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met.
monitorService	Monitor service on which the rule(monitor) is set.
severity	Severity of alert Sev0 being highest and Sev4 being lowest.
signalType	The type of signal the alert is based on, which could be metrics, logs or activity logs.
smartGroupId	Unique Id of the smart group
smartGroupingReason	Verbose reason describing the reason why this alert instance is added to a smart group
sourceCreatedId	Unique Id created by monitor service for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc.
startDateTime	Creation time(ISO-8601 format) of alert instance.
targetResource	Target ARM resource, on which alert got created.
targetResourceGroup	Resource group of target ARM resource, on which alert got created.
targetResourceName	Name of the target ARM resource name, on which alert got created.
targetResourceType	Resource type of target ARM resource, on which alert got created.

Property Details

actionStatus

Action status

actionStatus?: ActionStatus

Property Value

ActionStatus

alertRule

Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule.

alertRule?: string

Property Value

string

alertState

Alert object state, which can be modified by the user.

alertState?: string

Property Value

string

description

Alert description.

description?: string

Property Value

string

lastModifiedDateTime

Last modification time(ISO-8601 format) of alert instance.

lastModifiedDateTime?: Date

Property Value

Date

lastModifiedUserName

User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user.

lastModifiedUserName?: string

Property Value

string

monitorCondition

Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds.

monitorCondition?: string

Property Value

string

monitorConditionResolvedDateTime

Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met.

monitorConditionResolvedDateTime?: Date

Property Value

Date

monitorService

Monitor service on which the rule(monitor) is set.

monitorService?: string

Property Value

string

severity

Severity of alert Sev0 being highest and Sev4 being lowest.

severity?: string

Property Value

string

signalType

The type of signal the alert is based on, which could be metrics, logs or activity logs.

signalType?: string

Property Value

string

smartGroupId

Unique Id of the smart group

smartGroupId?: string

Property Value

string

smartGroupingReason

Verbose reason describing the reason why this alert instance is added to a smart group

smartGroupingReason?: string

Property Value

string

sourceCreatedId

Unique Id created by monitor service for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc.

sourceCreatedId?: string

Property Value

string

startDateTime

Creation time(ISO-8601 format) of alert instance.

startDateTime?: Date

Property Value

Date

targetResource

Target ARM resource, on which alert got created.

targetResource?: string

Property Value

string

targetResourceGroup

Resource group of target ARM resource, on which alert got created.

targetResourceGroup?: string

Property Value

string

targetResourceName

Name of the target ARM resource name, on which alert got created.

targetResourceName?: string

Property Value

string

targetResourceType

Resource type of target ARM resource, on which alert got created.

targetResourceType?: string

Property Value

string