microsoft.insights actionGroups template reference

Template format

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

{
  "name": "string",
  "type": "microsoft.insights/actionGroups",
  "apiVersion": "2019-06-01",
  "location": "string",
  "tags": {},
  "properties": {
    "groupShortName": "string",
    "enabled": "boolean",
    "emailReceivers": [
      {
        "name": "string",
        "emailAddress": "string",
        "useCommonAlertSchema": "boolean"
      }
    ],
    "smsReceivers": [
      {
        "name": "string",
        "countryCode": "string",
        "phoneNumber": "string"
      }
    ],
    "webhookReceivers": [
      {
        "name": "string",
        "serviceUri": "string",
        "useCommonAlertSchema": "boolean",
        "useAadAuth": "boolean",
        "objectId": "string",
        "identifierUri": "string",
        "tenantId": "string"
      }
    ],
    "itsmReceivers": [
      {
        "name": "string",
        "workspaceId": "string",
        "connectionId": "string",
        "ticketConfiguration": "string",
        "region": "string"
      }
    ],
    "azureAppPushReceivers": [
      {
        "name": "string",
        "emailAddress": "string"
      }
    ],
    "automationRunbookReceivers": [
      {
        "automationAccountId": "string",
        "runbookName": "string",
        "webhookResourceId": "string",
        "isGlobalRunbook": "boolean",
        "name": "string",
        "serviceUri": "string",
        "useCommonAlertSchema": "boolean"
      }
    ],
    "voiceReceivers": [
      {
        "name": "string",
        "countryCode": "string",
        "phoneNumber": "string"
      }
    ],
    "logicAppReceivers": [
      {
        "name": "string",
        "resourceId": "string",
        "callbackUrl": "string",
        "useCommonAlertSchema": "boolean"
      }
    ],
    "azureFunctionReceivers": [
      {
        "name": "string",
        "functionAppResourceId": "string",
        "functionName": "string",
        "httpTriggerUrl": "string",
        "useCommonAlertSchema": "boolean"
      }
    ],
    "armRoleReceivers": [
      {
        "name": "string",
        "roleId": "string",
        "useCommonAlertSchema": "boolean"
      }
    ]
  }
}

Property values

The following tables describe the values you need to set in the schema.

microsoft.insights/actionGroups object

Name Type Required Value
name string Yes The name of the action group.
type enum Yes microsoft.insights/actionGroups
apiVersion enum Yes 2019-06-01
location string Yes Resource location
tags object No Resource tags
properties object Yes The action groups properties of the resource. - ActionGroup object

ActionGroup object

Name Type Required Value
groupShortName string Yes The short name of the action group. This will be used in SMS messages.
enabled boolean Yes Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
emailReceivers array No The list of email receivers that are part of this action group. - EmailReceiver object
smsReceivers array No The list of SMS receivers that are part of this action group. - SmsReceiver object
webhookReceivers array No The list of webhook receivers that are part of this action group. - WebhookReceiver object
itsmReceivers array No The list of ITSM receivers that are part of this action group. - ItsmReceiver object
azureAppPushReceivers array No The list of AzureAppPush receivers that are part of this action group. - AzureAppPushReceiver object
automationRunbookReceivers array No The list of AutomationRunbook receivers that are part of this action group. - AutomationRunbookReceiver object
voiceReceivers array No The list of voice receivers that are part of this action group. - VoiceReceiver object
logicAppReceivers array No The list of logic app receivers that are part of this action group. - LogicAppReceiver object
azureFunctionReceivers array No The list of azure function receivers that are part of this action group. - AzureFunctionReceiver object
armRoleReceivers array No 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 object

EmailReceiver object

Name Type Required Value
name string Yes The name of the email receiver. Names must be unique across all receivers within an action group.
emailAddress string Yes The email address of this receiver.
useCommonAlertSchema boolean Yes Indicates whether to use common alert schema.

SmsReceiver object

Name Type Required Value
name string Yes The name of the SMS receiver. Names must be unique across all receivers within an action group.
countryCode string Yes The country code of the SMS receiver.
phoneNumber string Yes The phone number of the SMS receiver.

WebhookReceiver object

Name Type Required Value
name string Yes The name of the webhook receiver. Names must be unique across all receivers within an action group.
serviceUri string Yes The URI where webhooks should be sent.
useCommonAlertSchema boolean Yes Indicates whether to use common alert schema.
useAadAuth boolean No Indicates whether or not use AAD authentication.
objectId string No Indicates the webhook app object Id for aad auth.
identifierUri string No Indicates the identifier uri for aad auth.
tenantId string No Indicates the tenant id for aad auth.

ItsmReceiver object

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

AzureAppPushReceiver object

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

AutomationRunbookReceiver object

Name Type Required Value
automationAccountId string Yes The Azure automation account Id which holds this runbook and authenticate to Azure resource.
runbookName string Yes The name for this runbook.
webhookResourceId string Yes The resource id for webhook linked to this runbook.
isGlobalRunbook boolean Yes Indicates whether this instance is global runbook.
name string No Indicates name of the webhook.
serviceUri string No The URI where webhooks should be sent.
useCommonAlertSchema boolean Yes Indicates whether to use common alert schema.

VoiceReceiver object

Name Type Required Value
name string Yes The name of the voice receiver. Names must be unique across all receivers within an action group.
countryCode string Yes The country code of the voice receiver.
phoneNumber string Yes The phone number of the voice receiver.

LogicAppReceiver object

Name Type Required Value
name string Yes The name of the logic app receiver. Names must be unique across all receivers within an action group.
resourceId string Yes The azure resource id of the logic app receiver.
callbackUrl string Yes The callback url where http request sent to.
useCommonAlertSchema boolean Yes Indicates whether to use common alert schema.

AzureFunctionReceiver object

Name Type Required Value
name string Yes The name of the azure function receiver. Names must be unique across all receivers within an action group.
functionAppResourceId string Yes The azure resource id of the function app.
functionName string Yes The function name in the function app.
httpTriggerUrl string Yes The http trigger url where http request sent to.
useCommonAlertSchema boolean Yes Indicates whether to use common alert schema.

ArmRoleReceiver object

Name Type Required Value
name string Yes The name of the arm role receiver. Names must be unique across all receivers within an action group.
roleId string Yes The arm role id.
useCommonAlertSchema boolean Yes Indicates whether to use common alert schema.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Creates an Azure service alert

Deploy to Azure
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

Deploy to Azure
This template allows you to deploy Application Insight and create alert in it
Create a new action groupn on Azure.

Deploy to 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

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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