prometheus_rule_groups

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

Overview

Name	prometheus_rule_groups
Type	Resource
Id	azure.alerts_management.prometheus_rule_groups

Fields

The following fields are returned by SELECT queries:

get

Successful request for a list of Prometheus rule groups

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The Prometheus rule group properties of the resource.
tags	object	Resource tags.

list_by_resource_group

Successful request for a list of Prometheus rule groups

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The Prometheus rule group properties of the resource.
tags	object	Resource tags.

list_by_subscription

Successful request for a list of Prometheus rule groups

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The Prometheus rule group properties of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, ruleGroupName		Retrieve a Prometheus rule group definition.
list_by_resource_group	select	subscriptionId, resourceGroupName		Retrieve Prometheus rule group definitions in a resource group.
list_by_subscription	select	subscriptionId		Retrieve Prometheus all rule group definitions in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, ruleGroupName, data__properties		Create or update a Prometheus rule group definition.
update	update	subscriptionId, resourceGroupName, ruleGroupName		Update an Prometheus rule group definition.
delete	delete	subscriptionId, resourceGroupName, ruleGroupName		Delete a Prometheus rule group 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.
ruleGroupName	string	The name of the rule group.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Retrieve a Prometheus rule group definition.

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

list_by_resource_group

Retrieve Prometheus rule group definitions in a resource group.

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

list_by_subscription

Retrieve Prometheus all rule group definitions in a subscription.

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

INSERT examples

create_or_update

Create or update a Prometheus rule group definition.

INSERT INTO azure.alerts_management.prometheus_rule_groups (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
ruleGroupName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ ruleGroupName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: prometheus_rule_groups
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the prometheus_rule_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the prometheus_rule_groups resource.
    - name: ruleGroupName
      value: string
      description: Required parameter for the prometheus_rule_groups resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        The Prometheus rule group properties of the resource.

UPDATE examples

update

Update an Prometheus rule group definition.

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

DELETE examples

delete

Delete a Prometheus rule group definition.

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