action_groups

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

Overview

Name	action_groups
Type	Resource
Id	azure.monitor.action_groups

Fields

The following fields are returned by SELECT queries:

get

The request succeeded.

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

list_by_resource_group

The request succeeded.

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

list_by_subscription_id

The request succeeded.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The action groups properties of the resource.
tags	object	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, actionGroupName, subscriptionId		Get an action group.
list_by_resource_group	select	resourceGroupName, subscriptionId		Get a list of all action groups in a resource group.
list_by_subscription_id	select	subscriptionId		Get a list of all action groups in a subscription.
create_or_update	insert	resourceGroupName, actionGroupName, subscriptionId		Create a new action group or update an existing one.
update	update	subscriptionId, resourceGroupName, actionGroupName		Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.
delete	delete	resourceGroupName, actionGroupName, subscriptionId		Delete an action group.
enable_receiver	exec	resourceGroupName, actionGroupName, subscriptionId, receiverName		Enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.
reconcile_nsp	exec	subscriptionId, resourceGroupName, actionGroupName, networkSecurityPerimeterConfigurationName		Reconciles a specified NSP configuration for specified action group.

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
actionGroupName	string	The name of the action group.
networkSecurityPerimeterConfigurationName	string	The name for a network security perimeter configuration
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get an action group.

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

list_by_resource_group

Get a list of all action groups in a resource group.

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

list_by_subscription_id

Get a list of all action groups in a subscription.

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

INSERT examples

create_or_update

Create a new action group or update an existing one.

INSERT INTO azure.monitor.action_groups (
data__location,
data__tags,
data__properties,
resourceGroupName,
actionGroupName,
subscriptionId
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ actionGroupName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: action_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the action_groups resource.
    - name: actionGroupName
      value: string
      description: Required parameter for the action_groups resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the action_groups resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags
    - name: properties
      value: object
      description: |
        The action groups properties of the resource.

UPDATE examples

update

Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.

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

DELETE examples

delete

Delete an action group.

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

Lifecycle Methods

enable_receiver

Enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.

EXEC azure.monitor.action_groups.enable_receiver 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@actionGroupName='{{ actionGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"receiverName": "{{ receiverName }}"
}'
;

reconcile_nsp

Reconciles a specified NSP configuration for specified action group.

EXEC azure.monitor.action_groups.reconcile_nsp 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@actionGroupName='{{ actionGroupName }}' --required, 
@networkSecurityPerimeterConfigurationName='{{ networkSecurityPerimeterConfigurationName }}' --required
;