alert_incidents

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

Overview

Name	alert_incidents
Type	Resource
Id	azure.authorization.alert_incidents

Fields

The following fields are returned by SELECT queries:

get

OK - Returns information about the alert incident.

Name	Datatype	Description
id	string	The alert incident ID.
name	string	The alert incident name.
properties	object	Alert incident properties.
type	string	The alert incident type.

list_for_scope

OK - Returns an array of alert incidents.

Name	Datatype	Description
id	string	The alert incident ID.
name	string	The alert incident name.
properties	object	Alert incident properties.
type	string	The alert incident type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, alertId, alertIncidentId		Get the specified alert incident.
list_for_scope	select	scope, alertId		Gets alert incidents for a resource scope.
remediate	exec	scope, alertId, alertIncidentId		Remediate an alert incident.

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
alertId	string	The name of the alert.
alertIncidentId	string	The name of the alert incident to remediate.
scope	string	The scope of the alert incident.

SELECT examples

get

Get the specified alert incident.

SELECT
id,
name,
properties,
type
FROM azure.authorization.alert_incidents
WHERE scope = '{{ scope }}' -- required
AND alertId = '{{ alertId }}' -- required
AND alertIncidentId = '{{ alertIncidentId }}' -- required
;

list_for_scope

Gets alert incidents for a resource scope.

SELECT
id,
name,
properties,
type
FROM azure.authorization.alert_incidents
WHERE scope = '{{ scope }}' -- required
AND alertId = '{{ alertId }}' -- required
;

Lifecycle Methods

remediate

Remediate an alert incident.

EXEC azure.authorization.alert_incidents.remediate 
@scope='{{ scope }}' --required, 
@alertId='{{ alertId }}' --required, 
@alertIncidentId='{{ alertIncidentId }}' --required
;