microsoft.insights actionGroups 2018-03-01

• Latest
• 2023-09-01-preview
• 2023-01-01
• 2022-06-01
• 2022-04-01
• 2021-09-01
• 2019-06-01
• 2019-03-01
• 2018-09-01
• 2018-03-01
• 2017-04-01

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.

Remarks

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

Resource format

To create a microsoft.insights/actionGroups resource, add the following Bicep to your template.

resource symbolicname 'microsoft.insights/actionGroups@2018-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    automationRunbookReceivers: [
      {
        automationAccountId: 'string'
        isGlobalRunbook: bool
        name: 'string'
        runbookName: 'string'
        serviceUri: 'string'
        webhookResourceId: 'string'
      }
    ]
    azureAppPushReceivers: [
      {
        emailAddress: 'string'
        name: 'string'
      }
    ]
    azureFunctionReceivers: [
      {
        functionAppResourceId: 'string'
        functionName: 'string'
        httpTriggerUrl: 'string'
        name: 'string'
      }
    ]
    emailReceivers: [
      {
        emailAddress: 'string'
        name: 'string'
      }
    ]
    enabled: bool
    groupShortName: 'string'
    itsmReceivers: [
      {
        connectionId: 'string'
        name: 'string'
        region: 'string'
        ticketConfiguration: 'string'
        workspaceId: 'string'
      }
    ]
    logicAppReceivers: [
      {
        callbackUrl: 'string'
        name: 'string'
        resourceId: 'string'
      }
    ]
    smsReceivers: [
      {
        countryCode: 'string'
        name: 'string'
        phoneNumber: 'string'
      }
    ]
    voiceReceivers: [
      {
        countryCode: 'string'
        name: 'string'
        phoneNumber: 'string'
      }
    ]
    webhookReceivers: [
      {
        name: 'string'
        serviceUri: 'string'
      }
    ]
  }
}

Property values

actionGroups

Name	Description	Value
name	The resource name	string (required) Character limit: 1-260 Valid characters: Can't use: :<>+/&%\?| or control characters Can't end with space or period.
location	Resource location	string (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
properties	The action groups properties of the resource.	ActionGroup

ActionGroup

Name	Description	Value
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)
groupShortName	The short name of the action group. This will be used in SMS messages.	string (required) Constraints: Max length = 12
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[]

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)
name	Indicates name of the webhook.	string
runbookName	The name for this runbook.	string (required)
serviceUri	The URI where webhooks should be sent.	string
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)
name	The name of the azure function receiver. Names must be unique across all receivers within an action group.	string (required)

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)

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)
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)

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)

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
name	The name of the webhook receiver. Names must be unique across all receivers within an action group.	string (required)
serviceUri	The URI where webhooks should be sent.	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
BrowserBox Azure Edition	This template deploys BrowserBox on an Azure Ubuntu Server 22.04 LTS, Debian 11, or RHEL 8.7 LVM VM.
Scalable Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
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.
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.
Dynamic Web Test Creation	Create any number of App Insights web (ping) tests.
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.
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 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 Application Insight and create alert in it	This template allows you to deploy Application Insight and create alert in it
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.
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

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.

Remarks

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

Resource format

To create a microsoft.insights/actionGroups resource, add the following JSON to your template.

{
  "type": "microsoft.insights/actionGroups",
  "apiVersion": "2018-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "automationRunbookReceivers": [
      {
        "automationAccountId": "string",
        "isGlobalRunbook": "bool",
        "name": "string",
        "runbookName": "string",
        "serviceUri": "string",
        "webhookResourceId": "string"
      }
    ],
    "azureAppPushReceivers": [
      {
        "emailAddress": "string",
        "name": "string"
      }
    ],
    "azureFunctionReceivers": [
      {
        "functionAppResourceId": "string",
        "functionName": "string",
        "httpTriggerUrl": "string",
        "name": "string"
      }
    ],
    "emailReceivers": [
      {
        "emailAddress": "string",
        "name": "string"
      }
    ],
    "enabled": "bool",
    "groupShortName": "string",
    "itsmReceivers": [
      {
        "connectionId": "string",
        "name": "string",
        "region": "string",
        "ticketConfiguration": "string",
        "workspaceId": "string"
      }
    ],
    "logicAppReceivers": [
      {
        "callbackUrl": "string",
        "name": "string",
        "resourceId": "string"
      }
    ],
    "smsReceivers": [
      {
        "countryCode": "string",
        "name": "string",
        "phoneNumber": "string"
      }
    ],
    "voiceReceivers": [
      {
        "countryCode": "string",
        "name": "string",
        "phoneNumber": "string"
      }
    ],
    "webhookReceivers": [
      {
        "name": "string",
        "serviceUri": "string"
      }
    ]
  }
}

Property values

actionGroups

Name	Description	Value
type	The resource type	'microsoft.insights/actionGroups'
apiVersion	The resource api version	'2018-03-01'
name	The resource name	string (required) Character limit: 1-260 Valid characters: Can't use: :<>+/&%\?| or control characters Can't end with space or period.
location	Resource location	string (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
properties	The action groups properties of the resource.	ActionGroup

ActionGroup

Name	Description	Value
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)
groupShortName	The short name of the action group. This will be used in SMS messages.	string (required) Constraints: Max length = 12
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[]

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)
name	Indicates name of the webhook.	string
runbookName	The name for this runbook.	string (required)
serviceUri	The URI where webhooks should be sent.	string
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)
name	The name of the azure function receiver. Names must be unique across all receivers within an action group.	string (required)

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)

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)
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)

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)

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
name	The name of the webhook receiver. Names must be unique across all receivers within an action group.	string (required)
serviceUri	The URI where webhooks should be sent.	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
BrowserBox Azure Edition	This template deploys BrowserBox on an Azure Ubuntu Server 22.04 LTS, Debian 11, or RHEL 8.7 LVM VM.
Scalable Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
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.
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.
Dynamic Web Test Creation	Create any number of App Insights web (ping) tests.
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.
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 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 Application Insight and create alert in it	This template allows you to deploy Application Insight and create alert in it
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.
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

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.

Resource format

To create a microsoft.insights/actionGroups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "microsoft.insights/actionGroups@2018-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      automationRunbookReceivers = [
        {
          automationAccountId = "string"
          isGlobalRunbook = bool
          name = "string"
          runbookName = "string"
          serviceUri = "string"
          webhookResourceId = "string"
        }
      ]
      azureAppPushReceivers = [
        {
          emailAddress = "string"
          name = "string"
        }
      ]
      azureFunctionReceivers = [
        {
          functionAppResourceId = "string"
          functionName = "string"
          httpTriggerUrl = "string"
          name = "string"
        }
      ]
      emailReceivers = [
        {
          emailAddress = "string"
          name = "string"
        }
      ]
      enabled = bool
      groupShortName = "string"
      itsmReceivers = [
        {
          connectionId = "string"
          name = "string"
          region = "string"
          ticketConfiguration = "string"
          workspaceId = "string"
        }
      ]
      logicAppReceivers = [
        {
          callbackUrl = "string"
          name = "string"
          resourceId = "string"
        }
      ]
      smsReceivers = [
        {
          countryCode = "string"
          name = "string"
          phoneNumber = "string"
        }
      ]
      voiceReceivers = [
        {
          countryCode = "string"
          name = "string"
          phoneNumber = "string"
        }
      ]
      webhookReceivers = [
        {
          name = "string"
          serviceUri = "string"
        }
      ]
    }
  })
}

Property values

actionGroups

Name	Description	Value
type	The resource type	"microsoft.insights/actionGroups@2018-03-01"
name	The resource name	string (required) Character limit: 1-260 Valid characters: Can't use: :<>+/&%\?| or control characters Can't end with space or period.
location	Resource location	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags	Dictionary of tag names and values.
properties	The action groups properties of the resource.	ActionGroup

ActionGroup

Name	Description	Value
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)
groupShortName	The short name of the action group. This will be used in SMS messages.	string (required) Constraints: Max length = 12
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[]

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)
name	Indicates name of the webhook.	string
runbookName	The name for this runbook.	string (required)
serviceUri	The URI where webhooks should be sent.	string
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)
name	The name of the azure function receiver. Names must be unique across all receivers within an action group.	string (required)

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)

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)
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)

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)

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
name	The name of the webhook receiver. Names must be unique across all receivers within an action group.	string (required)
serviceUri	The URI where webhooks should be sent.	string (required)