alert_processing_rules

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

Overview

Name	alert_processing_rules
Type	Resource
Id	azure.alerts_management.alert_processing_rules

Fields

The following fields are returned by SELECT queries:

get_by_name

OK. Returns the specific alert processing rule.

Name	Datatype	Description
location	string	Resource location
properties	object	Alert processing rule properties.
systemData	object	Alert processing rule system data.
tags	object	Resource tags

list_by_resource_group

OK. Return the list of alert processing rules.

Name	Datatype	Description
location	string	Resource location
properties	object	Alert processing rule properties.
systemData	object	Alert processing rule system data.
tags	object	Resource tags

list_by_subscription

OK. Return the list of alert processing rules.

Name	Datatype	Description
location	string	Resource location
properties	object	Alert processing rule properties.
systemData	object	Alert processing rule system data.
tags	object	Resource tags

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_name	select	subscriptionId, resourceGroupName, alertProcessingRuleName		Get an alert processing rule by name.
list_by_resource_group	select	subscriptionId, resourceGroupName		List all alert processing rules in a resource group.
list_by_subscription	select	subscriptionId		List all alert processing rules in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, alertProcessingRuleName		Create or update an alert processing rule.
update	update	subscriptionId, resourceGroupName, alertProcessingRuleName		Enable, disable, or update tags for an alert processing rule.
delete	delete	subscriptionId, resourceGroupName, alertProcessingRuleName		Delete an alert processing rule.

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
alertProcessingRuleName	string	The name of the alert processing rule that needs to be deleted.
resourceGroupName	string	Resource group name where the resource is created.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get_by_name

Get an alert processing rule by name.

SELECT
location,
properties,
systemData,
tags
FROM azure.alerts_management.alert_processing_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND alertProcessingRuleName = '{{ alertProcessingRuleName }}' -- required
;

list_by_resource_group

List all alert processing rules in a resource group.

SELECT
location,
properties,
systemData,
tags
FROM azure.alerts_management.alert_processing_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List all alert processing rules in a subscription.

SELECT
location,
properties,
systemData,
tags
FROM azure.alerts_management.alert_processing_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update an alert processing rule.

INSERT INTO azure.alerts_management.alert_processing_rules (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
alertProcessingRuleName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ alertProcessingRuleName }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: alert_processing_rules
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the alert_processing_rules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the alert_processing_rules resource.
    - name: alertProcessingRuleName
      value: string
      description: Required parameter for the alert_processing_rules resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags
    - name: properties
      value: object
      description: |
        Alert processing rule properties.

UPDATE examples

update

Enable, disable, or update tags for an alert processing rule.

UPDATE azure.alerts_management.alert_processing_rules
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND alertProcessingRuleName = '{{ alertProcessingRuleName }}' --required
RETURNING
location,
properties,
systemData,
tags;

DELETE examples

delete

Delete an alert processing rule.

DELETE FROM azure.alerts_management.alert_processing_rules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND alertProcessingRuleName = '{{ alertProcessingRuleName }}' --required
;