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_test_notifications_at_action_group_resource_level

Name	Datatype	Description
actionDetails	array	The list of action detail.
completedTime	string	The completed time.
context	object	The context info.
createdTime	string	The created time.
state	string	The overall state. Required.

get_nsp

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
networkSecurityPerimeter	object	Information about a network security perimeter (NSP).
profile	object	:vartype profile: ~azure.mgmt.monitor.models.NetworkSecurityProfile
provisioningIssues	array	List of provisioning issues, if any.
provisioningState	string	Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", "Failed", and "Canceled". (Succeeded, Creating, Updating, Deleting, Accepted, Failed, Canceled)
resourceAssociation	object	:vartype resource_association: ~azure.mgmt.monitor.models.ResourceAssociation
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
armRoleReceivers	array	The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
automationRunbookReceivers	array	The list of AutomationRunbook receivers that are part of this action group.
azureAppPushReceivers	array	The list of AzureAppPush receivers that are part of this action group.
azureFunctionReceivers	array	The list of azure function receivers that are part of this action group.
emailReceivers	array	The list of email receivers that are part of this action group.
enabled	boolean	Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Required.
eventHubReceivers	array	The list of event hub receivers that are part of this action group.
groupShortName	string	The short name of the action group. This will be used in SMS messages. Required.
identity	object	The managed service identities assigned to this resource.
incidentReceivers	array	The list of incident receivers that are part of this action group.
itsmReceivers	array	The list of ITSM receivers that are part of this action group.
location	string	The geo-location where the resource lives. Required.
logicAppReceivers	array	The list of logic app receivers that are part of this action group.
smsReceivers	array	The list of SMS receivers that are part of this action group.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
voiceReceivers	array	The list of voice receivers that are part of this action group.
webhookReceivers	array	The list of webhook receivers that are part of this action group.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
armRoleReceivers	array	The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
automationRunbookReceivers	array	The list of AutomationRunbook receivers that are part of this action group.
azureAppPushReceivers	array	The list of AzureAppPush receivers that are part of this action group.
azureFunctionReceivers	array	The list of azure function receivers that are part of this action group.
emailReceivers	array	The list of email receivers that are part of this action group.
enabled	boolean	Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Required.
eventHubReceivers	array	The list of event hub receivers that are part of this action group.
groupShortName	string	The short name of the action group. This will be used in SMS messages. Required.
identity	object	The managed service identities assigned to this resource.
incidentReceivers	array	The list of incident receivers that are part of this action group.
itsmReceivers	array	The list of ITSM receivers that are part of this action group.
location	string	The geo-location where the resource lives. Required.
logicAppReceivers	array	The list of logic app receivers that are part of this action group.
smsReceivers	array	The list of SMS receivers that are part of this action group.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
voiceReceivers	array	The list of voice receivers that are part of this action group.
webhookReceivers	array	The list of webhook receivers that are part of this action group.

list_by_subscription_id

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
armRoleReceivers	array	The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
automationRunbookReceivers	array	The list of AutomationRunbook receivers that are part of this action group.
azureAppPushReceivers	array	The list of AzureAppPush receivers that are part of this action group.
azureFunctionReceivers	array	The list of azure function receivers that are part of this action group.
emailReceivers	array	The list of email receivers that are part of this action group.
enabled	boolean	Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Required.
eventHubReceivers	array	The list of event hub receivers that are part of this action group.
groupShortName	string	The short name of the action group. This will be used in SMS messages. Required.
identity	object	The managed service identities assigned to this resource.
incidentReceivers	array	The list of incident receivers that are part of this action group.
itsmReceivers	array	The list of ITSM receivers that are part of this action group.
location	string	The geo-location where the resource lives. Required.
logicAppReceivers	array	The list of logic app receivers that are part of this action group.
smsReceivers	array	The list of SMS receivers that are part of this action group.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
voiceReceivers	array	The list of voice receivers that are part of this action group.
webhookReceivers	array	The list of webhook receivers that are part of this action group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_test_notifications_at_action_group_resource_level	select	resource_group_name, action_group_name, notification_id, subscription_id		Get the test notifications by the notification id.
get_nsp	select	resource_group_name, action_group_name, network_security_perimeter_configuration_name, subscription_id		Gets a specified NSP configuration for specified action group.
get	select	resource_group_name, action_group_name, subscription_id		Get an action group.
list_by_resource_group	select	resource_group_name, subscription_id		Get a list of all action groups in a resource group.
list_by_subscription_id	select	subscription_id		Get a list of all action groups in a subscription.
create_or_update	insert	resource_group_name, action_group_name, subscription_id, location		Create a new action group or update an existing one.
update	update	resource_group_name, action_group_name, subscription_id		Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.
create_or_update	replace	resource_group_name, action_group_name, subscription_id, location		Create a new action group or update an existing one.
delete	delete	resource_group_name, action_group_name, subscription_id		Delete an action group.
list_nsp	exec	resource_group_name, action_group_name, subscription_id		Gets a list of NSP configurations for specified action group.
create_notifications_at_action_group_resource_level	exec	resource_group_name, action_group_name, subscription_id, alertType		Send test notifications to a set of provided receivers.
enable_receiver	exec	resource_group_name, action_group_name, subscription_id, 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	resource_group_name, action_group_name, network_security_perimeter_configuration_name, subscription_id		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
action_group_name	string	The name of the action group. Required.
network_security_perimeter_configuration_name	string	The name for a network security perimeter configuration. Required.
notification_id	string	The notification id. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get_test_notifications_at_action_group_resource_level

Get the test notifications by the notification id.

SELECT
actionDetails,
completedTime,
context,
createdTime,
state
FROM azure.monitor.action_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND action_group_name = '{{ action_group_name }}' -- required
AND notification_id = '{{ notification_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_nsp

Gets a specified NSP configuration for specified action group.

SELECT
id,
name,
networkSecurityPerimeter,
profile,
provisioningIssues,
provisioningState,
resourceAssociation,
systemData,
type
FROM azure.monitor.action_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND action_group_name = '{{ action_group_name }}' -- required
AND network_security_perimeter_configuration_name = '{{ network_security_perimeter_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get an action group.

SELECT
id,
name,
armRoleReceivers,
automationRunbookReceivers,
azureAppPushReceivers,
azureFunctionReceivers,
emailReceivers,
enabled,
eventHubReceivers,
groupShortName,
identity,
incidentReceivers,
itsmReceivers,
location,
logicAppReceivers,
smsReceivers,
systemData,
tags,
type,
voiceReceivers,
webhookReceivers
FROM azure.monitor.action_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND action_group_name = '{{ action_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
armRoleReceivers,
automationRunbookReceivers,
azureAppPushReceivers,
azureFunctionReceivers,
emailReceivers,
enabled,
eventHubReceivers,
groupShortName,
identity,
incidentReceivers,
itsmReceivers,
location,
logicAppReceivers,
smsReceivers,
systemData,
tags,
type,
voiceReceivers,
webhookReceivers
FROM azure.monitor.action_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription_id

Get a list of all action groups in a subscription.

SELECT
id,
name,
armRoleReceivers,
automationRunbookReceivers,
azureAppPushReceivers,
azureFunctionReceivers,
emailReceivers,
enabled,
eventHubReceivers,
groupShortName,
identity,
incidentReceivers,
itsmReceivers,
location,
logicAppReceivers,
smsReceivers,
systemData,
tags,
type,
voiceReceivers,
webhookReceivers
FROM azure.monitor.action_groups
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a new action group or update an existing one.

INSERT INTO azure.monitor.action_groups (
tags,
location,
properties,
identity,
resource_group_name,
action_group_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ action_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: action_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the action_groups resource.
  - name: action_group_name
    value: "{{ action_group_name }}"
    description: Required parameter for the action_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the action_groups resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The action groups properties of the resource.
    value:
      groupShortName: "{{ groupShortName }}"
      enabled: {{ enabled }}
      emailReceivers:
        - name: "{{ name }}"
          emailAddress: "{{ emailAddress }}"
          useCommonAlertSchema: {{ useCommonAlertSchema }}
          status: "{{ status }}"
      smsReceivers:
        - name: "{{ name }}"
          countryCode: "{{ countryCode }}"
          phoneNumber: "{{ phoneNumber }}"
          status: "{{ status }}"
      webhookReceivers:
        - name: "{{ name }}"
          serviceUri: "{{ serviceUri }}"
          useCommonAlertSchema: {{ useCommonAlertSchema }}
          useAadAuth: {{ useAadAuth }}
          objectId: "{{ objectId }}"
          identifierUri: "{{ identifierUri }}"
          tenantId: "{{ tenantId }}"
          managedIdentity: "{{ managedIdentity }}"
      itsmReceivers:
        - name: "{{ name }}"
          workspaceId: "{{ workspaceId }}"
          connectionId: "{{ connectionId }}"
          ticketConfiguration: "{{ ticketConfiguration }}"
          region: "{{ region }}"
      azureAppPushReceivers:
        - name: "{{ name }}"
          emailAddress: "{{ emailAddress }}"
      automationRunbookReceivers:
        - automationAccountId: "{{ automationAccountId }}"
          runbookName: "{{ runbookName }}"
          webhookResourceId: "{{ webhookResourceId }}"
          isGlobalRunbook: {{ isGlobalRunbook }}
          name: "{{ name }}"
          serviceUri: "{{ serviceUri }}"
          useCommonAlertSchema: {{ useCommonAlertSchema }}
          managedIdentity: "{{ managedIdentity }}"
      voiceReceivers:
        - name: "{{ name }}"
          countryCode: "{{ countryCode }}"
          phoneNumber: "{{ phoneNumber }}"
      logicAppReceivers:
        - name: "{{ name }}"
          resourceId: "{{ resourceId }}"
          callbackUrl: "{{ callbackUrl }}"
          useCommonAlertSchema: {{ useCommonAlertSchema }}
          managedIdentity: "{{ managedIdentity }}"
      azureFunctionReceivers:
        - name: "{{ name }}"
          functionAppResourceId: "{{ functionAppResourceId }}"
          functionName: "{{ functionName }}"
          httpTriggerUrl: "{{ httpTriggerUrl }}"
          useCommonAlertSchema: {{ useCommonAlertSchema }}
          managedIdentity: "{{ managedIdentity }}"
      armRoleReceivers:
        - name: "{{ name }}"
          roleId: "{{ roleId }}"
          useCommonAlertSchema: {{ useCommonAlertSchema }}
      eventHubReceivers:
        - name: "{{ name }}"
          eventHubNameSpace: "{{ eventHubNameSpace }}"
          eventHubName: "{{ eventHubName }}"
          useCommonAlertSchema: {{ useCommonAlertSchema }}
          tenantId: "{{ tenantId }}"
          subscriptionId: "{{ subscriptionId }}"
          managedIdentity: "{{ managedIdentity }}"
      incidentReceivers:
        - name: "{{ name }}"
          connection:
            name: "{{ name }}"
            id: "{{ id }}"
          incidentManagementService: "{{ incidentManagementService }}"
          mappings: "{{ mappings }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

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

UPDATE azure.monitor.action_groups
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND action_group_name = '{{ action_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a new action group or update an existing one.

REPLACE azure.monitor.action_groups
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND action_group_name = '{{ action_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete an action group.

DELETE FROM azure.monitor.action_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND action_group_name = '{{ action_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_nsp

Gets a list of NSP configurations for specified action group.

EXEC azure.monitor.action_groups.list_nsp 
@resource_group_name='{{ resource_group_name }}' --required, 
@action_group_name='{{ action_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_notifications_at_action_group_resource_level

Send test notifications to a set of provided receivers.

EXEC azure.monitor.action_groups.create_notifications_at_action_group_resource_level 
@resource_group_name='{{ resource_group_name }}' --required, 
@action_group_name='{{ action_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"alertType": "{{ alertType }}", 
"emailReceivers": "{{ emailReceivers }}", 
"smsReceivers": "{{ smsReceivers }}", 
"webhookReceivers": "{{ webhookReceivers }}", 
"itsmReceivers": "{{ itsmReceivers }}", 
"azureAppPushReceivers": "{{ azureAppPushReceivers }}", 
"automationRunbookReceivers": "{{ automationRunbookReceivers }}", 
"voiceReceivers": "{{ voiceReceivers }}", 
"logicAppReceivers": "{{ logicAppReceivers }}", 
"azureFunctionReceivers": "{{ azureFunctionReceivers }}", 
"armRoleReceivers": "{{ armRoleReceivers }}", 
"eventHubReceivers": "{{ eventHubReceivers }}", 
"incidentReceivers": "{{ incidentReceivers }}"
}'
;

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 
@resource_group_name='{{ resource_group_name }}' --required, 
@action_group_name='{{ action_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"receiverName": "{{ receiverName }}"
}'
;

reconcile_nsp

Reconciles a specified NSP configuration for specified action group.

EXEC azure.monitor.action_groups.reconcile_nsp 
@resource_group_name='{{ resource_group_name }}' --required, 
@action_group_name='{{ action_group_name }}' --required, 
@network_security_perimeter_configuration_name='{{ network_security_perimeter_configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;