alert_definitions

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

Overview

Name	alert_definitions
Type	Resource
Id	azure.authorization.alert_definitions

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.
description	string	The alert description.
displayName	string	The alert display name.
howToPrevent	string	The ways to prevent the alert.
isConfigurable	boolean	True if the alert configuration can be configured; false, otherwise.
isRemediatable	boolean	True if the alert can be remediated; false, otherwise.
mitigationSteps	string	The methods to mitigate the alert.
scope	string	The alert scope.
securityImpact	string	Security impact of the alert.
severityLevel	string	Severity level of the alert. Known values are: "Low", "Medium", and "High". (Low, Medium, High)
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.
description	string	The alert description.
displayName	string	The alert display name.
howToPrevent	string	The ways to prevent the alert.
isConfigurable	boolean	True if the alert configuration can be configured; false, otherwise.
isRemediatable	boolean	True if the alert can be remediated; false, otherwise.
mitigationSteps	string	The methods to mitigate the alert.
scope	string	The alert scope.
securityImpact	string	Security impact of the alert.
severityLevel	string	Severity level of the alert. Known values are: "Low", "Medium", and "High". (Low, Medium, High)
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_definition_id		Get the specified alert definition.
list_for_scope	select	scope		Gets alert definitions for a resource scope.

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_definition_id	string	The name of the alert definition to get. Required.
scope	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Get the specified alert definition.

SELECT
id,
name,
description,
displayName,
howToPrevent,
isConfigurable,
isRemediatable,
mitigationSteps,
scope,
securityImpact,
severityLevel,
systemData,
type
FROM azure.authorization.alert_definitions
WHERE scope = '{{ scope }}' -- required
AND alert_definition_id = '{{ alert_definition_id }}' -- required
;

list_for_scope

Gets alert definitions for a resource scope.

SELECT
id,
name,
description,
displayName,
howToPrevent,
isConfigurable,
isRemediatable,
mitigationSteps,
scope,
securityImpact,
severityLevel,
systemData,
type
FROM azure.authorization.alert_definitions
WHERE scope = '{{ scope }}' -- required
;