metric_alerts

Creates, updates, deletes, gets or lists a metric_alerts resource.

Overview

Name	metric_alerts
Type	Resource
Id	azure.monitor.metric_alerts

Fields

The following fields are returned by SELECT queries:

get

Successful request for a list of metric alerts

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 metric alerts

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 metric alerts

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	subscriptionId, resourceGroupName, ruleName		Retrieve an alert rule definition.
list_by_resource_group	select	subscriptionId, resourceGroupName		Retrieve alert rule definitions in a resource group.
list_by_subscription	select	subscriptionId		Retrieve alert rule definitions in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, ruleName, data__properties		Create or update an metric alert definition.
update	update	subscriptionId, resourceGroupName, ruleName		Update an metric alert definition.
delete	delete	subscriptionId, resourceGroupName, ruleName		Delete an alert rule definition.

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

Retrieve an alert rule definition.

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

list_by_resource_group

Retrieve alert rule definitions in a resource group.

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

list_by_subscription

Retrieve alert rule definitions in a subscription.

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

INSERT examples

create_or_update

Create or update an metric alert definition.

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

Manifest

# Description fields are for documentation purposes
- name: metric_alerts
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the metric_alerts resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the metric_alerts resource.
    - name: ruleName
      value: string
      description: Required parameter for the metric_alerts 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

Update an metric alert definition.

UPDATE azure.monitor.metric_alerts
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

Delete an alert rule definition.

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