Kickstart your project with AVM templates.

action-groups

report

If you believe that this package or its contents contain harmful information, please inform us.
Please be aware that we will never share your credentials.

This package contains:

Please let us know what this package contains.

Email address

Please enter a valid email address.

Please provide is us with more information.

This Bicep AVM module deploys an Action Group.

ipm add --package avm-bicep/action-groups --version 0.5.0

Published: 15-03-2025

Project URL: https://ipmhub.io/avm-bicep

Package Type: Bicep

License: MIT

Action Groups `[Microsoft.Insights/actionGroups]`

This module deploys an Action Group.

Resource Types

Resource Type	API Version
`Microsoft.Authorization/roleAssignments`	2022-04-01
`Microsoft.Insights/actionGroups`	2023-01-01

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.

via Bicep module

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

via JSON parameters file

{
  "$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"
    },
    // Non-required parameters
    "location": {
      "value": "global"
    }
  }
}

via Bicep parameters file

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

// Required parameters
param groupShortName = 'agiagmin001'
param name = 'iagmin001'
// Non-required parameters
param location = 'global'

Example 2: Using large parameter set

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

via Bicep module

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'
    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'
    }
  }
}

via JSON parameters file

{
  "$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"
    },
    "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"
      }
    }
  }
}

via Bicep parameters file

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

via Bicep module

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

via JSON parameters file

{
  "$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
    "location": {
      "value": "global"
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

via Bicep parameters file

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

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

Parameters

Required parameters

Parameter	Type	Description
`groupShortName`	string	The short name of the action group.
`name`	string	The name of the action group.

Optional parameters

Parameter	Type	Description
`armRoleReceivers`	array	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.
`automationRunbookReceivers`	array	The list of AutomationRunbook receivers that are part of this action group.
`azureAppPushReceivers`	array	The list of AzureAppPush receivers that are part of this action group.
`azureFunctionReceivers`	array	The list of function receivers that are part of this action group.
`emailReceivers`	array	The list of email receivers that are part of this action group.
`enabled`	bool	Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
`enableTelemetry`	bool	Enable/Disable usage telemetry for module.
`eventHubReceivers`	array	The list of Event Hub receivers that are part of this action group.
`itsmReceivers`	array	The list of ITSM receivers that are part of this action group.
`location`	string	Location for all resources.
`logicAppReceivers`	array	The list of logic app receivers that are part of this action group.
`roleAssignments`	array	Array of role assignments to create.
`smsReceivers`	array	The list of SMS receivers that are part of this action group.
`tags`	object	Tags of the resource.
`voiceReceivers`	array	The list of voice receivers that are part of this action group.
`webhookReceivers`	array	The list of webhook receivers that are part of this action group.

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: `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: `logicAppReceivers`

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

Required: No
Type: array

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

Parameter	Type	Description
`principalId`	string	The principal ID of the principal (user/group/identity) to assign the role to.
`roleDefinitionIdOrName`	string	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'.

Optional parameters

Parameter	Type	Description
`condition`	string	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".
`conditionVersion`	string	Version of the condition.
`delegatedManagedIdentityResourceId`	string	The Resource Id of the delegated managed identity resource.
`description`	string	The description of the role assignment.
`name`	string	The name (as GUID) of the role assignment. If not provided, a GUID will be generated.
`principalType`	string	The principal type of the assigned principal ID.

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

Output	Type	Description
`location`	string	The location the resource was deployed into.
`name`	string	The name of the action group.
`resourceGroupName`	string	The resource group the action group was deployed into.
`resourceId`	string	The resource ID of the action group.

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

Reference	Type
`./packages/utl-common-types/main.bicep`	Local Reference

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.

No release notes uploaded for this version

 
 {
  "workingFolder": "packages",
  "packages": [
    // packages defined earlier
    {
      "name": "avm-bicep/action-groups",
      "version": "0.5.0"
    }
  ]
}

avm-bicep/utl-common-types:0.5.1

Stats

Selected version:

0.5.0

Downloads this version:

Downloads all versions:

Latest version:

0.5.0

Latest update:

15-03-2025

avm-bicep

Other versions (3)

0.5.0

0.4.1

0.4.0

Other packages

from avm-bicep

action-rules

action-groups

aad-domain-services

View all from publisher

Kickstart your project with AVM templates.

Report Package action-groups

Action Groups [Microsoft.Insights/actionGroups]

Navigation

Resource Types

Usage examples

Example 1: Using only defaults

Example 2: Using large parameter set

Example 3: WAF-aligned

Parameters

Parameter: groupShortName

Parameter: name

Parameter: armRoleReceivers

Parameter: automationRunbookReceivers

Parameter: azureAppPushReceivers

Parameter: azureFunctionReceivers

Parameter: emailReceivers

Parameter: enabled

Parameter: enableTelemetry

Parameter: eventHubReceivers

Parameter: itsmReceivers

Parameter: location

Parameter: logicAppReceivers

Parameter: roleAssignments

Parameter: roleAssignments.principalId

Parameter: roleAssignments.roleDefinitionIdOrName

Parameter: roleAssignments.condition

Parameter: roleAssignments.conditionVersion

Parameter: roleAssignments.delegatedManagedIdentityResourceId

Parameter: roleAssignments.description

Parameter: roleAssignments.name

Parameter: roleAssignments.principalType

Parameter: smsReceivers

Parameter: tags

Parameter: voiceReceivers

Parameter: webhookReceivers

Outputs

Cross-referenced modules

Data Collection

Stats

avm-bicep

Other versions (3)

Other packages

from avm-bicep

Action Groups `[Microsoft.Insights/actionGroups]`

Parameter: `groupShortName`

Parameter: `name`

Parameter: `armRoleReceivers`

Parameter: `automationRunbookReceivers`

Parameter: `azureAppPushReceivers`

Parameter: `azureFunctionReceivers`

Parameter: `emailReceivers`

Parameter: `enabled`

Parameter: `enableTelemetry`

Parameter: `eventHubReceivers`

Parameter: `itsmReceivers`

Parameter: `location`

Parameter: `logicAppReceivers`

Parameter: `roleAssignments`

Parameter: `roleAssignments.principalId`

Parameter: `roleAssignments.roleDefinitionIdOrName`

Parameter: `roleAssignments.condition`

Parameter: `roleAssignments.conditionVersion`

Parameter: `roleAssignments.delegatedManagedIdentityResourceId`

Parameter: `roleAssignments.description`

Parameter: `roleAssignments.name`

Parameter: `roleAssignments.principalType`

Parameter: `smsReceivers`

Parameter: `tags`

Parameter: `voiceReceivers`

Parameter: `webhookReceivers`