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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
alertIncidentType	string	The alert incident type. Required. Default value is None.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_for_scope

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
alertIncidentType	string	The alert incident type. Required. Default value is None.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, alert_id, alert_incident_id		Get the specified alert incident.
list_for_scope	select	scope, alert_id		Gets alert incidents for a resource scope.
remediate	exec	scope, alert_id, alert_incident_id		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
alert_id	string	The name of the alert to get. Required.
alert_incident_id	string	The name of the alert incident to get. Required.
scope	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Get the specified alert incident.

SELECT
id,
name,
alertIncidentType,
systemData,
type
FROM azure.authorization.alert_incidents
WHERE scope = '{{ scope }}' -- required
AND alert_id = '{{ alert_id }}' -- required
AND alert_incident_id = '{{ alert_incident_id }}' -- required
;

list_for_scope

Gets alert incidents for a resource scope.

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

Lifecycle Methods

remediate

Remediate an alert incident.

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