Microsoft.Insights actionGroups

Remarks

For guidance on deploying monitoring solutions, see Create monitoring resources by using Bicep.

Bicep resource definition

The actionGroups resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Usage Examples

Bicep Samples

A basic example of deploying Action Group within Azure Monitor.

param location string = 'westeurope'
param resourceName string = 'acctest0001'

resource actionGroup 'Microsoft.Insights/actionGroups@2023-01-01' = {
  name: resourceName
  location: 'global'
  properties: {
    armRoleReceivers: []
    automationRunbookReceivers: []
    azureAppPushReceivers: []
    azureFunctionReceivers: []
    emailReceivers: []
    enabled: true
    eventHubReceivers: []
    groupShortName: 'acctestag'
    itsmReceivers: []
    logicAppReceivers: []
    smsReceivers: []
    voiceReceivers: []
    webhookReceivers: []
  }
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module	Description
Action Group	AVM Resource Module for Action Group

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File	Description
AKS Cluster with a NAT Gateway and an Application Gateway	This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections.
AKS cluster with the Application Gateway Ingress Controller	This sample shows how to deploy an AKS cluster with Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics and Key Vault
Create a new action groupn on Azure	This template creates a new Action group on Azure, this action group can be then used for configuring alerts on Azure.
Creates an Azure service alert	This template creates an Azure service health alert that optionally sends emails to service administrators and specified email addresses in the event of cerain Azure service outages.
Deploy Application Insight and create alert in it	This template allows you to deploy Application Insight and create alert in it
Setup notifications for backup alerts using Azure Monitor	This template enables you to setup email notifications for your Recovery Services vaults using Azure Monitor, by deploying an alert processing rule and an action group

Resource format

To create a Microsoft.Insights/actionGroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Insights/actionGroups@2024-10-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    armRoleReceivers: [
      {
        name: 'string'
        roleId: 'string'
        useCommonAlertSchema: bool
      }
    ]
    automationRunbookReceivers: [
      {
        automationAccountId: 'string'
        isGlobalRunbook: bool
        managedIdentity: 'string'
        name: 'string'
        runbookName: 'string'
        serviceUri: 'string'
        useCommonAlertSchema: bool
        webhookResourceId: 'string'
      }
    ]
    azureAppPushReceivers: [
      {
        emailAddress: 'string'
        name: 'string'
      }
    ]
    azureFunctionReceivers: [
      {
        functionAppResourceId: 'string'
        functionName: 'string'
        httpTriggerUrl: 'string'
        managedIdentity: 'string'
        name: 'string'
        useCommonAlertSchema: bool
      }
    ]
    emailReceivers: [
      {
        emailAddress: 'string'
        name: 'string'
        useCommonAlertSchema: bool
      }
    ]
    enabled: bool
    eventHubReceivers: [
      {
        eventHubName: 'string'
        eventHubNameSpace: 'string'
        managedIdentity: 'string'
        name: 'string'
        subscriptionId: 'string'
        tenantId: 'string'
        useCommonAlertSchema: bool
      }
    ]
    groupShortName: 'string'
    incidentReceivers: [
      {
        connection: {
          id: 'string'
          name: 'string'
        }
        incidentManagementService: 'string'
        mappings: {
          {customized property}: 'string'
        }
        name: 'string'
      }
    ]
    itsmReceivers: [
      {
        connectionId: 'string'
        name: 'string'
        region: 'string'
        ticketConfiguration: 'string'
        workspaceId: 'string'
      }
    ]
    logicAppReceivers: [
      {
        callbackUrl: 'string'
        managedIdentity: 'string'
        name: 'string'
        resourceId: 'string'
        useCommonAlertSchema: bool
      }
    ]
    smsReceivers: [
      {
        countryCode: 'string'
        name: 'string'
        phoneNumber: 'string'
      }
    ]
    voiceReceivers: [
      {
        countryCode: 'string'
        name: 'string'
        phoneNumber: 'string'
      }
    ]
    webhookReceivers: [
      {
        identifierUri: 'string'
        managedIdentity: 'string'
        name: 'string'
        objectId: 'string'
        serviceUri: 'string'
        tenantId: 'string'
        useAadAuth: bool
        useCommonAlertSchema: bool
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Insights/actionGroups

Name	Description	Value
identity	The managed service identities assigned to this resource.	ManagedServiceIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	The action groups properties of the resource.	ActionGroup
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ActionGroup

Name	Description	Value
armRoleReceivers	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.	ArmRoleReceiver[]
automationRunbookReceivers	The list of AutomationRunbook receivers that are part of this action group.	AutomationRunbookReceiver[]
azureAppPushReceivers	The list of AzureAppPush receivers that are part of this action group.	AzureAppPushReceiver[]
azureFunctionReceivers	The list of azure function receivers that are part of this action group.	AzureFunctionReceiver[]
emailReceivers	The list of email receivers that are part of this action group.	EmailReceiver[]
enabled	Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.	bool (required)
eventHubReceivers	The list of event hub receivers that are part of this action group.	EventHubReceiver[]
groupShortName	The short name of the action group. This will be used in SMS messages.	string Constraints: Max length = 12 (required)
incidentReceivers	The list of incident receivers that are part of this action group.	IncidentReceiver[]
itsmReceivers	The list of ITSM receivers that are part of this action group.	ItsmReceiver[]
logicAppReceivers	The list of logic app receivers that are part of this action group.	LogicAppReceiver[]
smsReceivers	The list of SMS receivers that are part of this action group.	SmsReceiver[]
voiceReceivers	The list of voice receivers that are part of this action group.	VoiceReceiver[]
webhookReceivers	The list of webhook receivers that are part of this action group.	WebhookReceiver[]

ArmRoleReceiver

Name	Description	Value
name	The name of the arm role receiver. Names must be unique across all receivers within an action group.	string (required)
roleId	The arm role id.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

AutomationRunbookReceiver

Name	Description	Value
automationAccountId	The Azure automation account Id which holds this runbook and authenticate to Azure resource.	string (required)
isGlobalRunbook	Indicates whether this instance is global runbook.	bool (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	Indicates name of the webhook.	string
runbookName	The name for this runbook.	string (required)
serviceUri	The URI where webhooks should be sent.	string
useCommonAlertSchema	Indicates whether to use common alert schema.	bool
webhookResourceId	The resource id for webhook linked to this runbook.	string (required)

AzureAppPushReceiver

Name	Description	Value
emailAddress	The email address registered for the Azure mobile app.	string (required)
name	The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.	string (required)

AzureFunctionReceiver

Name	Description	Value
functionAppResourceId	The azure resource id of the function app.	string (required)
functionName	The function name in the function app.	string (required)
httpTriggerUrl	The http trigger url where http request sent to.	string (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the azure function receiver. Names must be unique across all receivers within an action group.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

EmailReceiver

Name	Description	Value
emailAddress	The email address of this receiver.	string (required)
name	The name of the email receiver. Names must be unique across all receivers within an action group.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

EventHubReceiver

Name	Description	Value
eventHubName	The name of the specific Event Hub queue	string (required)
eventHubNameSpace	The Event Hub namespace	string (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the Event hub receiver. Names must be unique across all receivers within an action group.	string (required)
subscriptionId	The Id for the subscription containing this event hub	string (required)
tenantId	The tenant Id for the subscription containing this event hub	string
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

IncidentReceiver

Name	Description	Value
connection	The incident service connection	IncidentServiceConnection (required)
incidentManagementService	The incident management service type	'Icm' (required)
mappings	Field mappings for the incident service	IncidentReceiverMappings (required)
name	The name of the Incident receiver. Names must be unique across all receivers within an action group.	string (required)

IncidentReceiverMappings

Name	Description	Value

IncidentServiceConnection

Name	Description	Value
id	GUID value representing the connection ID for the incident management service.	string (required)
name	The name of the connection.	string (required)

ItsmReceiver

Name	Description	Value
connectionId	Unique identification of ITSM connection among multiple defined in above workspace.	string (required)
name	The name of the Itsm receiver. Names must be unique across all receivers within an action group.	string (required)
region	Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'	string (required)
ticketConfiguration	JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.	string (required)
workspaceId	OMS LA instance identifier.	string (required)

LogicAppReceiver

Name	Description	Value
callbackUrl	The callback url where http request sent to.	string (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the logic app receiver. Names must be unique across all receivers within an action group.	string (required)
resourceId	The azure resource id of the logic app receiver.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

SmsReceiver

Name	Description	Value
countryCode	The country code of the SMS receiver.	string (required)
name	The name of the SMS receiver. Names must be unique across all receivers within an action group.	string (required)
phoneNumber	The phone number of the SMS receiver.	string (required)

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

VoiceReceiver

Name	Description	Value
countryCode	The country code of the voice receiver.	string (required)
name	The name of the voice receiver. Names must be unique across all receivers within an action group.	string (required)
phoneNumber	The phone number of the voice receiver.	string (required)

WebhookReceiver

Name	Description	Value
identifierUri	Indicates the identifier uri for aad auth.	string
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the webhook receiver. Names must be unique across all receivers within an action group.	string (required)
objectId	Indicates the webhook app object Id for aad auth.	string
serviceUri	The URI where webhooks should be sent.	string (required)
tenantId	Indicates the tenant id for aad auth.	string
useAadAuth	Indicates whether or not use AAD authentication.	bool
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

ARM template resource definition

The actionGroups resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
AKS Cluster with a NAT Gateway and an Application Gateway	This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections.
AKS cluster with the Application Gateway Ingress Controller	This sample shows how to deploy an AKS cluster with Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics and Key Vault
BrowserBox Azure Edition	This template deploys BrowserBox on an Azure Ubuntu Server 22.04 LTS, Debian 11, or RHEL 8.7 LVM VM.
Create a new action groupn on Azure	This template creates a new Action group on Azure, this action group can be then used for configuring alerts on Azure.
Creates an Azure service alert	This template creates an Azure service health alert that optionally sends emails to service administrators and specified email addresses in the event of cerain Azure service outages.
Deploy a Service Health Alert	This template allows you to deploy a simple alert which uses an action group to send email notifications for any Service Health records in the Azure Activity Log
Deploy an Autoscale Activity Log Alert	This template allows you to deploy a simple alert which uses an action group to send email notifications for any Autoscale records in the Azure Activity Log
Deploy an Autoscale Failed Activity Log Alert	This template allows you to deploy a simple alert which uses an action group to send email notifications for any failed Autoscale records in the Azure Activity Log
Deploy Application Insight and create alert in it	This template allows you to deploy Application Insight and create alert in it
Dynamic Web Test Creation	Create any number of App Insights web (ping) tests.
Enterprise Governance-AppService, SQL DB, AD, OMS, Runbooks	Cloud adoption for an Enterprise, small or large, require responsible and efficient governance models to derive value from their cloud deployments. CloudWise (a code-name for the solution), is a composite solution available from Azure Partner QuickStarts, is an adoption enabler for Customers, System Integrators and Partners alike, that delivers a self-serviceable, automated governance and operations solution, focused on Optimizing Your Costs, Improve Your Application(s) Reliability, Reducing Business Risk. The solution highlights the core governance pillars of Visibility and Control.
Scalable Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Setup notifications for backup alerts using Azure Monitor	This template enables you to setup email notifications for your Recovery Services vaults using Azure Monitor, by deploying an alert processing rule and an action group

Resource format

To create a Microsoft.Insights/actionGroups resource, add the following JSON to your template.

{
  "type": "Microsoft.Insights/actionGroups",
  "apiVersion": "2024-10-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "armRoleReceivers": [
      {
        "name": "string",
        "roleId": "string",
        "useCommonAlertSchema": "bool"
      }
    ],
    "automationRunbookReceivers": [
      {
        "automationAccountId": "string",
        "isGlobalRunbook": "bool",
        "managedIdentity": "string",
        "name": "string",
        "runbookName": "string",
        "serviceUri": "string",
        "useCommonAlertSchema": "bool",
        "webhookResourceId": "string"
      }
    ],
    "azureAppPushReceivers": [
      {
        "emailAddress": "string",
        "name": "string"
      }
    ],
    "azureFunctionReceivers": [
      {
        "functionAppResourceId": "string",
        "functionName": "string",
        "httpTriggerUrl": "string",
        "managedIdentity": "string",
        "name": "string",
        "useCommonAlertSchema": "bool"
      }
    ],
    "emailReceivers": [
      {
        "emailAddress": "string",
        "name": "string",
        "useCommonAlertSchema": "bool"
      }
    ],
    "enabled": "bool",
    "eventHubReceivers": [
      {
        "eventHubName": "string",
        "eventHubNameSpace": "string",
        "managedIdentity": "string",
        "name": "string",
        "subscriptionId": "string",
        "tenantId": "string",
        "useCommonAlertSchema": "bool"
      }
    ],
    "groupShortName": "string",
    "incidentReceivers": [
      {
        "connection": {
          "id": "string",
          "name": "string"
        },
        "incidentManagementService": "string",
        "mappings": {
          "{customized property}": "string"
        },
        "name": "string"
      }
    ],
    "itsmReceivers": [
      {
        "connectionId": "string",
        "name": "string",
        "region": "string",
        "ticketConfiguration": "string",
        "workspaceId": "string"
      }
    ],
    "logicAppReceivers": [
      {
        "callbackUrl": "string",
        "managedIdentity": "string",
        "name": "string",
        "resourceId": "string",
        "useCommonAlertSchema": "bool"
      }
    ],
    "smsReceivers": [
      {
        "countryCode": "string",
        "name": "string",
        "phoneNumber": "string"
      }
    ],
    "voiceReceivers": [
      {
        "countryCode": "string",
        "name": "string",
        "phoneNumber": "string"
      }
    ],
    "webhookReceivers": [
      {
        "identifierUri": "string",
        "managedIdentity": "string",
        "name": "string",
        "objectId": "string",
        "serviceUri": "string",
        "tenantId": "string",
        "useAadAuth": "bool",
        "useCommonAlertSchema": "bool"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Insights/actionGroups

Name	Description	Value
apiVersion	The api version	'2024-10-01-preview'
identity	The managed service identities assigned to this resource.	ManagedServiceIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	The action groups properties of the resource.	ActionGroup
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Insights/actionGroups'

ActionGroup

Name	Description	Value
armRoleReceivers	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.	ArmRoleReceiver[]
automationRunbookReceivers	The list of AutomationRunbook receivers that are part of this action group.	AutomationRunbookReceiver[]
azureAppPushReceivers	The list of AzureAppPush receivers that are part of this action group.	AzureAppPushReceiver[]
azureFunctionReceivers	The list of azure function receivers that are part of this action group.	AzureFunctionReceiver[]
emailReceivers	The list of email receivers that are part of this action group.	EmailReceiver[]
enabled	Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.	bool (required)
eventHubReceivers	The list of event hub receivers that are part of this action group.	EventHubReceiver[]
groupShortName	The short name of the action group. This will be used in SMS messages.	string Constraints: Max length = 12 (required)
incidentReceivers	The list of incident receivers that are part of this action group.	IncidentReceiver[]
itsmReceivers	The list of ITSM receivers that are part of this action group.	ItsmReceiver[]
logicAppReceivers	The list of logic app receivers that are part of this action group.	LogicAppReceiver[]
smsReceivers	The list of SMS receivers that are part of this action group.	SmsReceiver[]
voiceReceivers	The list of voice receivers that are part of this action group.	VoiceReceiver[]
webhookReceivers	The list of webhook receivers that are part of this action group.	WebhookReceiver[]

ArmRoleReceiver

Name	Description	Value
name	The name of the arm role receiver. Names must be unique across all receivers within an action group.	string (required)
roleId	The arm role id.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

AutomationRunbookReceiver

Name	Description	Value
automationAccountId	The Azure automation account Id which holds this runbook and authenticate to Azure resource.	string (required)
isGlobalRunbook	Indicates whether this instance is global runbook.	bool (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	Indicates name of the webhook.	string
runbookName	The name for this runbook.	string (required)
serviceUri	The URI where webhooks should be sent.	string
useCommonAlertSchema	Indicates whether to use common alert schema.	bool
webhookResourceId	The resource id for webhook linked to this runbook.	string (required)

AzureAppPushReceiver

Name	Description	Value
emailAddress	The email address registered for the Azure mobile app.	string (required)
name	The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.	string (required)

AzureFunctionReceiver

Name	Description	Value
functionAppResourceId	The azure resource id of the function app.	string (required)
functionName	The function name in the function app.	string (required)
httpTriggerUrl	The http trigger url where http request sent to.	string (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the azure function receiver. Names must be unique across all receivers within an action group.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

EmailReceiver

Name	Description	Value
emailAddress	The email address of this receiver.	string (required)
name	The name of the email receiver. Names must be unique across all receivers within an action group.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

EventHubReceiver

Name	Description	Value
eventHubName	The name of the specific Event Hub queue	string (required)
eventHubNameSpace	The Event Hub namespace	string (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the Event hub receiver. Names must be unique across all receivers within an action group.	string (required)
subscriptionId	The Id for the subscription containing this event hub	string (required)
tenantId	The tenant Id for the subscription containing this event hub	string
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

IncidentReceiver

Name	Description	Value
connection	The incident service connection	IncidentServiceConnection (required)
incidentManagementService	The incident management service type	'Icm' (required)
mappings	Field mappings for the incident service	IncidentReceiverMappings (required)
name	The name of the Incident receiver. Names must be unique across all receivers within an action group.	string (required)

IncidentReceiverMappings

Name	Description	Value

IncidentServiceConnection

Name	Description	Value
id	GUID value representing the connection ID for the incident management service.	string (required)
name	The name of the connection.	string (required)

ItsmReceiver

Name	Description	Value
connectionId	Unique identification of ITSM connection among multiple defined in above workspace.	string (required)
name	The name of the Itsm receiver. Names must be unique across all receivers within an action group.	string (required)
region	Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'	string (required)
ticketConfiguration	JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.	string (required)
workspaceId	OMS LA instance identifier.	string (required)

LogicAppReceiver

Name	Description	Value
callbackUrl	The callback url where http request sent to.	string (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the logic app receiver. Names must be unique across all receivers within an action group.	string (required)
resourceId	The azure resource id of the logic app receiver.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

SmsReceiver

Name	Description	Value
countryCode	The country code of the SMS receiver.	string (required)
name	The name of the SMS receiver. Names must be unique across all receivers within an action group.	string (required)
phoneNumber	The phone number of the SMS receiver.	string (required)

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

VoiceReceiver

Name	Description	Value
countryCode	The country code of the voice receiver.	string (required)
name	The name of the voice receiver. Names must be unique across all receivers within an action group.	string (required)
phoneNumber	The phone number of the voice receiver.	string (required)

WebhookReceiver

Name	Description	Value
identifierUri	Indicates the identifier uri for aad auth.	string
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the webhook receiver. Names must be unique across all receivers within an action group.	string (required)
objectId	Indicates the webhook app object Id for aad auth.	string
serviceUri	The URI where webhooks should be sent.	string (required)
tenantId	Indicates the tenant id for aad auth.	string
useAadAuth	Indicates whether or not use AAD authentication.	bool
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

Terraform (AzAPI provider) resource definition

The actionGroups resource type can be deployed with operations that target:

Resource groups For a list of changed properties in each API version, see change log.

Usage Examples

Terraform Samples

A basic example of deploying Action Group within Azure Monitor.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "actionGroup" {
  type      = "Microsoft.Insights/actionGroups@2023-01-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = "global"
  body = {
    properties = {
      armRoleReceivers = [
      ]
      automationRunbookReceivers = [
      ]
      azureAppPushReceivers = [
      ]
      azureFunctionReceivers = [
      ]
      emailReceivers = [
      ]
      enabled = true
      eventHubReceivers = [
      ]
      groupShortName = "acctestag"
      itsmReceivers = [
      ]
      logicAppReceivers = [
      ]
      smsReceivers = [
      ]
      voiceReceivers = [
      ]
      webhookReceivers = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Resource format

To create a Microsoft.Insights/actionGroups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/actionGroups@2024-10-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      armRoleReceivers = [
        {
          name = "string"
          roleId = "string"
          useCommonAlertSchema = bool
        }
      ]
      automationRunbookReceivers = [
        {
          automationAccountId = "string"
          isGlobalRunbook = bool
          managedIdentity = "string"
          name = "string"
          runbookName = "string"
          serviceUri = "string"
          useCommonAlertSchema = bool
          webhookResourceId = "string"
        }
      ]
      azureAppPushReceivers = [
        {
          emailAddress = "string"
          name = "string"
        }
      ]
      azureFunctionReceivers = [
        {
          functionAppResourceId = "string"
          functionName = "string"
          httpTriggerUrl = "string"
          managedIdentity = "string"
          name = "string"
          useCommonAlertSchema = bool
        }
      ]
      emailReceivers = [
        {
          emailAddress = "string"
          name = "string"
          useCommonAlertSchema = bool
        }
      ]
      enabled = bool
      eventHubReceivers = [
        {
          eventHubName = "string"
          eventHubNameSpace = "string"
          managedIdentity = "string"
          name = "string"
          subscriptionId = "string"
          tenantId = "string"
          useCommonAlertSchema = bool
        }
      ]
      groupShortName = "string"
      incidentReceivers = [
        {
          connection = {
            id = "string"
            name = "string"
          }
          incidentManagementService = "string"
          mappings = {
            {customized property} = "string"
          }
          name = "string"
        }
      ]
      itsmReceivers = [
        {
          connectionId = "string"
          name = "string"
          region = "string"
          ticketConfiguration = "string"
          workspaceId = "string"
        }
      ]
      logicAppReceivers = [
        {
          callbackUrl = "string"
          managedIdentity = "string"
          name = "string"
          resourceId = "string"
          useCommonAlertSchema = bool
        }
      ]
      smsReceivers = [
        {
          countryCode = "string"
          name = "string"
          phoneNumber = "string"
        }
      ]
      voiceReceivers = [
        {
          countryCode = "string"
          name = "string"
          phoneNumber = "string"
        }
      ]
      webhookReceivers = [
        {
          identifierUri = "string"
          managedIdentity = "string"
          name = "string"
          objectId = "string"
          serviceUri = "string"
          tenantId = "string"
          useAadAuth = bool
          useCommonAlertSchema = bool
        }
      ]
    }
  }
}

Property Values

Microsoft.Insights/actionGroups

Name	Description	Value
identity	The managed service identities assigned to this resource.	ManagedServiceIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	The action groups properties of the resource.	ActionGroup
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Insights/actionGroups@2024-10-01-preview"

ActionGroup

Name	Description	Value
armRoleReceivers	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.	ArmRoleReceiver[]
automationRunbookReceivers	The list of AutomationRunbook receivers that are part of this action group.	AutomationRunbookReceiver[]
azureAppPushReceivers	The list of AzureAppPush receivers that are part of this action group.	AzureAppPushReceiver[]
azureFunctionReceivers	The list of azure function receivers that are part of this action group.	AzureFunctionReceiver[]
emailReceivers	The list of email receivers that are part of this action group.	EmailReceiver[]
enabled	Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.	bool (required)
eventHubReceivers	The list of event hub receivers that are part of this action group.	EventHubReceiver[]
groupShortName	The short name of the action group. This will be used in SMS messages.	string Constraints: Max length = 12 (required)
incidentReceivers	The list of incident receivers that are part of this action group.	IncidentReceiver[]
itsmReceivers	The list of ITSM receivers that are part of this action group.	ItsmReceiver[]
logicAppReceivers	The list of logic app receivers that are part of this action group.	LogicAppReceiver[]
smsReceivers	The list of SMS receivers that are part of this action group.	SmsReceiver[]
voiceReceivers	The list of voice receivers that are part of this action group.	VoiceReceiver[]
webhookReceivers	The list of webhook receivers that are part of this action group.	WebhookReceiver[]

ArmRoleReceiver

Name	Description	Value
name	The name of the arm role receiver. Names must be unique across all receivers within an action group.	string (required)
roleId	The arm role id.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

AutomationRunbookReceiver

Name	Description	Value
automationAccountId	The Azure automation account Id which holds this runbook and authenticate to Azure resource.	string (required)
isGlobalRunbook	Indicates whether this instance is global runbook.	bool (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	Indicates name of the webhook.	string
runbookName	The name for this runbook.	string (required)
serviceUri	The URI where webhooks should be sent.	string
useCommonAlertSchema	Indicates whether to use common alert schema.	bool
webhookResourceId	The resource id for webhook linked to this runbook.	string (required)

AzureAppPushReceiver

Name	Description	Value
emailAddress	The email address registered for the Azure mobile app.	string (required)
name	The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.	string (required)

AzureFunctionReceiver

Name	Description	Value
functionAppResourceId	The azure resource id of the function app.	string (required)
functionName	The function name in the function app.	string (required)
httpTriggerUrl	The http trigger url where http request sent to.	string (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the azure function receiver. Names must be unique across all receivers within an action group.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

EmailReceiver

Name	Description	Value
emailAddress	The email address of this receiver.	string (required)
name	The name of the email receiver. Names must be unique across all receivers within an action group.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

EventHubReceiver

Name	Description	Value
eventHubName	The name of the specific Event Hub queue	string (required)
eventHubNameSpace	The Event Hub namespace	string (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the Event hub receiver. Names must be unique across all receivers within an action group.	string (required)
subscriptionId	The Id for the subscription containing this event hub	string (required)
tenantId	The tenant Id for the subscription containing this event hub	string
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

IncidentReceiver

Name	Description	Value
connection	The incident service connection	IncidentServiceConnection (required)
incidentManagementService	The incident management service type	'Icm' (required)
mappings	Field mappings for the incident service	IncidentReceiverMappings (required)
name	The name of the Incident receiver. Names must be unique across all receivers within an action group.	string (required)

IncidentReceiverMappings

Name	Description	Value

IncidentServiceConnection

Name	Description	Value
id	GUID value representing the connection ID for the incident management service.	string (required)
name	The name of the connection.	string (required)

ItsmReceiver

Name	Description	Value
connectionId	Unique identification of ITSM connection among multiple defined in above workspace.	string (required)
name	The name of the Itsm receiver. Names must be unique across all receivers within an action group.	string (required)
region	Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'	string (required)
ticketConfiguration	JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.	string (required)
workspaceId	OMS LA instance identifier.	string (required)

LogicAppReceiver

Name	Description	Value
callbackUrl	The callback url where http request sent to.	string (required)
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the logic app receiver. Names must be unique across all receivers within an action group.	string (required)
resourceId	The azure resource id of the logic app receiver.	string (required)
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

SmsReceiver

Name	Description	Value
countryCode	The country code of the SMS receiver.	string (required)
name	The name of the SMS receiver. Names must be unique across all receivers within an action group.	string (required)
phoneNumber	The phone number of the SMS receiver.	string (required)

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

VoiceReceiver

Name	Description	Value
countryCode	The country code of the voice receiver.	string (required)
name	The name of the voice receiver. Names must be unique across all receivers within an action group.	string (required)
phoneNumber	The phone number of the voice receiver.	string (required)

WebhookReceiver

Name	Description	Value
identifierUri	Indicates the identifier uri for aad auth.	string
managedIdentity	The principal id of the managed identity. The value can be "None", "SystemAssigned"	string
name	The name of the webhook receiver. Names must be unique across all receivers within an action group.	string (required)
objectId	Indicates the webhook app object Id for aad auth.	string
serviceUri	The URI where webhooks should be sent.	string (required)
tenantId	Indicates the tenant id for aad auth.	string
useAadAuth	Indicates whether or not use AAD authentication.	bool
useCommonAlertSchema	Indicates whether to use common alert schema.	bool

Feedback

Was this page helpful?

Last updated on 2024-12-09