alert_configurations

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

Overview

Name	alert_configurations
Type	Resource
Id	azure.authorization.alert_configurations

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.
alertConfigurationType	string	The alert configuration type. Required. Default value is None.
alertDefinition	object	The alert definition.
alertDefinitionId	string	The alert definition ID.
isEnabled	boolean	True if the alert is enabled, false will disable the scanning for the specific alert.
scope	string	The alert scope.
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.
alertConfigurationType	string	The alert configuration type. Required. Default value is None.
alertDefinition	object	The alert definition.
alertDefinitionId	string	The alert definition ID.
isEnabled	boolean	True if the alert is enabled, false will disable the scanning for the specific alert.
scope	string	The alert scope.
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		Get the specified alert configuration.
list_for_scope	select	scope		Gets alert configurations for a resource scope.
update	update	scope, alert_id		Update an alert configuration.

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

SELECT examples

get

Get the specified alert configuration.

SELECT
id,
name,
alertConfigurationType,
alertDefinition,
alertDefinitionId,
isEnabled,
scope,
systemData,
type
FROM azure.authorization.alert_configurations
WHERE scope = '{{ scope }}' -- required
AND alert_id = '{{ alert_id }}' -- required
;

list_for_scope

Gets alert configurations for a resource scope.

SELECT
id,
name,
alertConfigurationType,
alertDefinition,
alertDefinitionId,
isEnabled,
scope,
systemData,
type
FROM azure.authorization.alert_configurations
WHERE scope = '{{ scope }}' -- required
;

UPDATE examples

update

Update an alert configuration.

UPDATE azure.authorization.alert_configurations
SET 
properties = '{{ properties }}'
WHERE 
scope = '{{ scope }}' --required
AND alert_id = '{{ alert_id }}' --required;