alert_rule_incidents

Creates, updates, deletes, gets or lists an alert_rule_incidents resource.

Overview

Name	alert_rule_incidents
Type	Resource
Id	azure.monitor.alert_rule_incidents

Fields

The following fields are returned by SELECT queries:

get

Successful request for one alert rule related incident

Name	Datatype	Description
name	string	Incident name.
activatedTime	string (date-time)	The time at which the incident was activated in ISO8601 format.
isActive	boolean	A boolean to indicate whether the incident is active or resolved.
resolvedTime	string (date-time)	The time at which the incident was resolved in ISO8601 format. If null, it means the incident is still active.
ruleName	string	Rule name that is associated with the incident.

list_by_alert_rule

Successful request for a list of alert rule related incidents

Name	Datatype	Description
name	string	Incident name.
activatedTime	string (date-time)	The time at which the incident was activated in ISO8601 format.
isActive	boolean	A boolean to indicate whether the incident is active or resolved.
resolvedTime	string (date-time)	The time at which the incident was resolved in ISO8601 format. If null, it means the incident is still active.
ruleName	string	Rule name that is associated with the incident.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, ruleName, incidentName, subscriptionId		Gets an incident associated to an alert rule
list_by_alert_rule	select	resourceGroupName, ruleName, subscriptionId		Gets a list of incidents associated to an alert rule

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
incidentName	string	The name of the incident to retrieve.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
ruleName	string	The name of the rule.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets an incident associated to an alert rule

SELECT
name,
activatedTime,
isActive,
resolvedTime,
ruleName
FROM azure.monitor.alert_rule_incidents
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND ruleName = '{{ ruleName }}' -- required
AND incidentName = '{{ incidentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_alert_rule

Gets a list of incidents associated to an alert rule

SELECT
name,
activatedTime,
isActive,
resolvedTime,
ruleName
FROM azure.monitor.alert_rule_incidents
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND ruleName = '{{ ruleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;