alert_rules

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

Overview

Name	alert_rules
Type	Resource
Id	azure.monitor.alert_rules

Fields

The following fields are returned by SELECT queries:

get

Successful request to get an alert rule

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The alert rule properties of the resource.
tags		Resource tags
type	string	Azure resource type

list_by_resource_group

Successful request for a list of alert rules

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The alert rule properties of the resource.
tags		Resource tags
type	string	Azure resource type

list_by_subscription

Successful request for a list of alert rules

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The alert rule properties of the resource.
tags		Resource tags
type	string	Azure resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, ruleName, subscriptionId		Gets a classic metric alert rule
list_by_resource_group	select	resourceGroupName, subscriptionId		List the classic metric alert rules within a resource group.
list_by_subscription	select	subscriptionId		List the classic metric alert rules within a subscription.
create_or_update	insert	resourceGroupName, ruleName, subscriptionId, data__properties		Creates or updates a classic metric alert rule.
update	update	subscriptionId, resourceGroupName, ruleName		Updates an existing classic metric AlertRuleResource. To update other fields use the CreateOrUpdate method.
delete	delete	resourceGroupName, ruleName, subscriptionId		Deletes a classic metric alert 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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
ruleName	string	The name of the rule.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a classic metric alert rule

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.alert_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND ruleName = '{{ ruleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

List the classic metric alert rules within a resource group.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.alert_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

List the classic metric alert rules within a subscription.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.alert_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a classic metric alert rule.

INSERT INTO azure.monitor.alert_rules (
data__location,
data__tags,
data__properties,
resourceGroupName,
ruleName,
subscriptionId
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ ruleName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: alert_rules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the alert_rules resource.
    - name: ruleName
      value: string
      description: Required parameter for the alert_rules resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the alert_rules resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: string
      description: |
        Resource tags
    - name: properties
      value: object
      description: |
        The alert rule properties of the resource.

UPDATE examples

update

Updates an existing classic metric AlertRuleResource. To update other fields use the CreateOrUpdate method.

UPDATE azure.monitor.alert_rules
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND ruleName = '{{ ruleName }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a classic metric alert rule

DELETE FROM azure.monitor.alert_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND ruleName = '{{ ruleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;