microsoft.insights actionGroups 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@2017-04-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'
      }
    ]
    emailReceivers: [
      {
        emailAddress: 'string'
        name: 'string'
      }
    ]
    enabled: bool
    groupShortName: 'string'
    itsmReceivers: [
      {
        connectionId: 'string'
        name: 'string'
        region: 'string'
        ticketConfiguration: 'string'
        workspaceId: 'string'
      }
    ]
    smsReceivers: [
      {
        countryCode: 'string'
        name: 'string'
        phoneNumber: 'string'
      }
    ]
    webhookReceivers: [
      {
        name: 'string'
        serviceUri: 'string'
      }
    ]
  }
}

Property values

actionGroups

ActionGroup

AutomationRunbookReceiver

AzureAppPushReceiver

EmailReceiver

ItsmReceiver

SmsReceiver

WebhookReceiver

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": "2017-04-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"
      }
    ],
    "emailReceivers": [
      {
        "emailAddress": "string",
        "name": "string"
      }
    ],
    "enabled": "bool",
    "groupShortName": "string",
    "itsmReceivers": [
      {
        "connectionId": "string",
        "name": "string",
        "region": "string",
        "ticketConfiguration": "string",
        "workspaceId": "string"
      }
    ],
    "smsReceivers": [
      {
        "countryCode": "string",
        "name": "string",
        "phoneNumber": "string"
      }
    ],
    "webhookReceivers": [
      {
        "name": "string",
        "serviceUri": "string"
      }
    ]
  }
}

Property values

actionGroups

ActionGroup

AutomationRunbookReceiver

AzureAppPushReceiver

EmailReceiver

ItsmReceiver

SmsReceiver

WebhookReceiver

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@2017-04-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"
        }
      ]
      emailReceivers = [
        {
          emailAddress = "string"
          name = "string"
        }
      ]
      enabled = bool
      groupShortName = "string"
      itsmReceivers = [
        {
          connectionId = "string"
          name = "string"
          region = "string"
          ticketConfiguration = "string"
          workspaceId = "string"
        }
      ]
      smsReceivers = [
        {
          countryCode = "string"
          name = "string"
          phoneNumber = "string"
        }
      ]
      webhookReceivers = [
        {
          name = "string"
          serviceUri = "string"
        }
      ]
    }
  })
}

Property values

actionGroups

ActionGroup

AutomationRunbookReceiver

AzureAppPushReceiver

EmailReceiver

ItsmReceiver

SmsReceiver

WebhookReceiver