Action Groups [Microsoft.Insights/actionGroups]

This module deploys an Action Group.

Navigation

• Resource Types
• Usage examples
• Parameters
• Outputs
• Cross-referenced modules
• Data Collection

Resource Types

Usage examples

The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.

Note: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

Note: To reference the module, please use the following syntax ./packages/action-groups/main.bicep.

• Using only defaults
• Using large parameter set
• WAF-aligned

Example 1: Using only defaults

This instance deploys the module with the minimum set of required parameters.

module actionGroup './packages/action-groups/main.bicep' = {
  name: 'actionGroupDeployment'
  params: {
    // Required parameters
    groupShortName: 'agiagmin001'
    name: 'iagmin001'
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "groupShortName": {
      "value": "agiagmin001"
    },
    "name": {
      "value": "iagmin001"
    }
  }
}

using './packages/action-groups/main.bicep'

// Required parameters
param groupShortName = 'agiagmin001'
param name = 'iagmin001'

Example 2: Using large parameter set

This instance deploys the module with most of its features enabled.

module actionGroup './packages/action-groups/main.bicep' = {
  name: 'actionGroupDeployment'
  params: {
    // Required parameters
    groupShortName: 'agiagmax001'
    name: 'iagmax001'
    // Non-required parameters
    emailReceivers: [
      {
        emailAddress: 'test.user@testcompany.com'
        name: 'TestUser_-EmailAction-'
        useCommonAlertSchema: true
      }
      {
        emailAddress: 'test.user2@testcompany.com'
        name: 'TestUser2'
        useCommonAlertSchema: true
      }
    ]
    location: 'global'
    lock: {
      kind: 'CanNotDelete'
      name: 'myCustomLockName'
    }
    roleAssignments: [
      {
        name: 'fc3ee4d9-d0c0-42c2-962f-082cf8d78882'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'Owner'
      }
      {
        name: '<name>'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
      }
      {
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
      }
    ]
    smsReceivers: [
      {
        countryCode: '1'
        name: 'TestUser_-SMSAction-'
        phoneNumber: '2345678901'
      }
    ]
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "groupShortName": {
      "value": "agiagmax001"
    },
    "name": {
      "value": "iagmax001"
    },
    // Non-required parameters
    "emailReceivers": {
      "value": [
        {
          "emailAddress": "test.user@testcompany.com",
          "name": "TestUser_-EmailAction-",
          "useCommonAlertSchema": true
        },
        {
          "emailAddress": "test.user2@testcompany.com",
          "name": "TestUser2",
          "useCommonAlertSchema": true
        }
      ]
    },
    "location": {
      "value": "global"
    },
    "lock": {
      "value": {
        "kind": "CanNotDelete",
        "name": "myCustomLockName"
      }
    },
    "roleAssignments": {
      "value": [
        {
          "name": "fc3ee4d9-d0c0-42c2-962f-082cf8d78882",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "Owner"
        },
        {
          "name": "<name>",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "b24988ac-6180-42a0-ab88-20f7382dd24c"
        },
        {
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "<roleDefinitionIdOrName>"
        }
      ]
    },
    "smsReceivers": {
      "value": [
        {
          "countryCode": "1",
          "name": "TestUser_-SMSAction-",
          "phoneNumber": "2345678901"
        }
      ]
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

using './packages/action-groups/main.bicep'

// Required parameters
param groupShortName = 'agiagmax001'
param name = 'iagmax001'
// Non-required parameters
param emailReceivers = [
  {
    emailAddress: 'test.user@testcompany.com'
    name: 'TestUser_-EmailAction-'
    useCommonAlertSchema: true
  }
  {
    emailAddress: 'test.user2@testcompany.com'
    name: 'TestUser2'
    useCommonAlertSchema: true
  }
]
param location = 'global'
param lock = {
  kind: 'CanNotDelete'
  name: 'myCustomLockName'
}
param roleAssignments = [
  {
    name: 'fc3ee4d9-d0c0-42c2-962f-082cf8d78882'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'Owner'
  }
  {
    name: '<name>'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
  }
  {
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
  }
]
param smsReceivers = [
  {
    countryCode: '1'
    name: 'TestUser_-SMSAction-'
    phoneNumber: '2345678901'
  }
]
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Example 3: WAF-aligned

This instance deploys the module in alignment with the best-practices of the Azure Well-Architected Framework.

module actionGroup './packages/action-groups/main.bicep' = {
  name: 'actionGroupDeployment'
  params: {
    // Required parameters
    groupShortName: 'agiagwaf001'
    name: 'iagwaf001'
    // Non-required parameters
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "groupShortName": {
      "value": "agiagwaf001"
    },
    "name": {
      "value": "iagwaf001"
    },
    // Non-required parameters
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

using './packages/action-groups/main.bicep'

// Required parameters
param groupShortName = 'agiagwaf001'
param name = 'iagwaf001'
// Non-required parameters
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Parameters

Required parameters

Optional parameters

Parameter: groupShortName

The short name of the action group.

• Required: Yes
• Type: string

Parameter: name

The name of the action group.

• Required: Yes
• Type: string

Parameter: 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.

• Required: No
• Type: array

Parameter: automationRunbookReceivers

The list of AutomationRunbook receivers that are part of this action group.

• Required: No
• Type: array

Parameter: azureAppPushReceivers

The list of AzureAppPush receivers that are part of this action group.

• Required: No
• Type: array

Parameter: azureFunctionReceivers

The list of function receivers that are part of this action group.

• Required: No
• Type: array

Parameter: emailReceivers

The list of email receivers that are part of this action group.

• Required: No
• Type: array

Parameter: enabled

Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.

• Required: No
• Type: bool
• Default: True

Parameter: enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool
• Default: True

Parameter: eventHubReceivers

The list of Event Hub receivers that are part of this action group.

• Required: No
• Type: array

Parameter: incidentReceivers

The list of incident receivers that are part of this action group.

• Required: No
• Type: array

Parameter: itsmReceivers

The list of ITSM receivers that are part of this action group.

• Required: No
• Type: array

Parameter: location

Location for all resources.

• Required: No
• Type: string
• Default: 'global'

Parameter: lock

The lock settings of the service.

• Required: No
• Type: object

Optional parameters

Parameter: lock.kind

Specify the type of lock.

• Required: No
• Type: string
• Allowed:

  [
    'CanNotDelete'
    'None'
    'ReadOnly'
  ]
  

Parameter: lock.name

Specify the name of lock.

• Required: No
• Type: string

Parameter: lock.notes

Specify the notes of the lock.

• Required: No
• Type: string

Parameter: logicAppReceivers

The list of logic app receivers that are part of this action group.

• Required: No
• Type: array

Required parameters

Optional parameters

Parameter: logicAppReceivers.callbackUrl

The callback url where http request sent to.

• Required: Yes
• Type: securestring

Parameter: logicAppReceivers.name

The name of the logic app receiver. Names must be unique across all receivers within an action group.

• Required: Yes
• Type: string

Parameter: logicAppReceivers.resourceId

The azure resource id of the logic app receiver.

• Required: Yes
• Type: string

Parameter: logicAppReceivers.managedIdentity

The principal id of the managed identity. The value can be "None", "SystemAssigned".

• Required: No
• Type: string

Parameter: logicAppReceivers.useCommonAlertSchema

Indicates whether to use common alert schema.

• Required: No
• Type: bool

Parameter: roleAssignments

Array of role assignments to create.

• Required: No
• Type: array
• Roles configurable by name:
  • 'Contributor'
  • 'Owner'
  • 'Reader'
  • 'Role Based Access Control Administrator'
  • 'User Access Administrator'

Required parameters

Optional parameters

Parameter: roleAssignments.principalId

The principal ID of the principal (user/group/identity) to assign the role to.

• Required: Yes
• Type: string

Parameter: roleAssignments.roleDefinitionIdOrName

The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.

• Required: Yes
• Type: string

Parameter: roleAssignments.condition

The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".

• Required: No
• Type: string

Parameter: roleAssignments.conditionVersion

Version of the condition.

• Required: No
• Type: string
• Allowed:

  [
    '2.0'
  ]
  

Parameter: roleAssignments.delegatedManagedIdentityResourceId

The Resource Id of the delegated managed identity resource.

• Required: No
• Type: string

Parameter: roleAssignments.description

The description of the role assignment.

• Required: No
• Type: string

Parameter: roleAssignments.name

The name (as GUID) of the role assignment. If not provided, a GUID will be generated.

• Required: No
• Type: string

Parameter: roleAssignments.principalType

The principal type of the assigned principal ID.

• Required: No
• Type: string
• Allowed:

  [
    'Device'
    'ForeignGroup'
    'Group'
    'ServicePrincipal'
    'User'
  ]
  

Parameter: smsReceivers

The list of SMS receivers that are part of this action group.

• Required: No
• Type: array

Parameter: tags

Tags of the resource.

• Required: No
• Type: object

Parameter: voiceReceivers

The list of voice receivers that are part of this action group.

• Required: No
• Type: array

Parameter: webhookReceivers

The list of webhook receivers that are part of this action group.

• Required: No
• Type: array

Outputs

Cross-referenced modules

This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.