alerts_suppression_rules

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

Overview

Name	alerts_suppression_rules
Type	Resource
Id	azure.security.alerts_suppression_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	describes AlertsSuppressionRule properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	describes AlertsSuppressionRule properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
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	subscriptionId, alertsSuppressionRuleName	api-version	Get dismiss rule, with name: {alertsSuppressionRuleName}, for the given subscription
list	select	subscriptionId	api-version, AlertType	List of all the dismiss rules for the given subscription
update	replace	subscriptionId, alertsSuppressionRuleName	api-version	Update existing rule or create new rule if it doesn't exist
delete	delete	subscriptionId, alertsSuppressionRuleName	api-version	Delete dismiss alert rule for this subscription.

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
alertsSuppressionRuleName	string	The unique name of the suppression alert rule
subscriptionId	string	Azure subscription ID
AlertType	string	Type of the alert to get rules for
api-version	string	API version for the operation

SELECT examples

get

Get dismiss rule, with name: {alertsSuppressionRuleName}, for the given subscription

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.alerts_suppression_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND alertsSuppressionRuleName = '{{ alertsSuppressionRuleName }}' -- required
AND api-version = '{{ api-version }}'
;

list

List of all the dismiss rules for the given subscription

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.alerts_suppression_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND AlertType = '{{ AlertType }}'
;

REPLACE examples

update

Update existing rule or create new rule if it doesn't exist

REPLACE azure.security.alerts_suppression_rules
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND alertsSuppressionRuleName = '{{ alertsSuppressionRuleName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete dismiss alert rule for this subscription.

DELETE FROM azure.security.alerts_suppression_rules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND alertsSuppressionRuleName = '{{ alertsSuppressionRuleName }}' --required
AND api-version = '{{ api-version }}'
;