Kickstart your project with AVM templates.

action-rules

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 Alert Processing Rule.

ipm add --package avm-bicep/action-rules --version 0.2.2

Published: 10-04-2025

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

Package Type: Bicep

License: MIT

Action Rules `[Microsoft.AlertsManagement/actionRules]`

This module deploys an Alert Processing Rule.

Resource Types

Resource Type	API Version
`Microsoft.AlertsManagement/actionRules`	2021-08-08
`Microsoft.Authorization/locks`	2020-05-01
`Microsoft.Authorization/roleAssignments`	2022-04-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-rules/main.bicep.

Using small parameter set
Using large parameter set
WAF-aligned

Example 1: Using small parameter set

This instance deploys the module with min features enabled.

via Bicep module

module actionRule './packages/action-rules/main.bicep' = {
  name: 'actionRuleDeployment'
  params: {
    // Required parameters
    name: 'aprmin001'
    // Non-required parameters
    location: '<location>'
  }
}

via JSON parameters file

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "aprmin001"
    },
    // Non-required parameters
    "location": {
      "value": "<location>"
    }
  }
}

via Bicep parameters file

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

// Required parameters
param name = 'aprmin001'
// Non-required parameters
param location = '<location>'

Example 2: Using large parameter set

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

via Bicep module

module actionRule './packages/action-rules/main.bicep' = {
  name: 'actionRuleDeployment'
  params: {
    // Required parameters
    name: 'aprmax001'
    // Non-required parameters
    actions: [
      {
        actionGroupIds: [
          '<actionGroupResourceId>'
        ]
        actionType: 'AddActionGroups'
      }
    ]
    aprDescription: 'Test deployment of the module with the max set of parameters.'
    conditions: [
      {
        field: 'AlertContext'
        operator: 'NotEquals'
        values: [
          'myAlertContext'
        ]
      }
      {
        field: 'AlertRuleId'
        operator: 'Equals'
        values: [
          '<activityLogAlertResourceId>'
        ]
      }
      {
        field: 'AlertRuleName'
        operator: 'Equals'
        values: [
          '<activityLogAlertResourceName>'
        ]
      }
      {
        field: 'Description'
        operator: 'Contains'
        values: [
          'myAlertRuleDescription'
        ]
      }
      {
        field: 'MonitorService'
        operator: 'Equals'
        values: [
          'ActivityLog Administrative'
        ]
      }
      {
        field: 'MonitorCondition'
        operator: 'Equals'
        values: [
          'Fired'
        ]
      }
      {
        field: 'TargetResourceType'
        operator: 'DoesNotContain'
        values: [
          'myAlertResourceType'
        ]
      }
      {
        field: 'TargetResource'
        operator: 'Equals'
        values: [
          'myAlertResource1'
          'myAlertResource2'
        ]
      }
      {
        field: 'TargetResourceGroup'
        operator: 'Equals'
        values: [
          '<id>'
        ]
      }
      {
        field: 'Severity'
        operator: 'Equals'
        values: [
          'Sev0'
          'Sev1'
          'Sev2'
          'Sev3'
          'Sev4'
        ]
      }
      {
        field: 'SignalType'
        operator: 'Equals'
        values: [
          'Health'
          'Log'
          'Metric'
          'Unknown'
        ]
      }
    ]
    enabled: true
    location: '<location>'
    lock: {
      kind: 'CanNotDelete'
      name: 'myCustomLockName'
    }
    roleAssignments: [
      {
        name: 'a66da6bc-b3ee-484e-9bdb-9294938bb327'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'Owner'
      }
      {
        name: '<name>'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
      }
      {
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
      }
    ]
    scopes: [
      '<id>'
    ]
    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
    "name": {
      "value": "aprmax001"
    },
    // Non-required parameters
    "actions": {
      "value": [
        {
          "actionGroupIds": [
            "<actionGroupResourceId>"
          ],
          "actionType": "AddActionGroups"
        }
      ]
    },
    "aprDescription": {
      "value": "Test deployment of the module with the max set of parameters."
    },
    "conditions": {
      "value": [
        {
          "field": "AlertContext",
          "operator": "NotEquals",
          "values": [
            "myAlertContext"
          ]
        },
        {
          "field": "AlertRuleId",
          "operator": "Equals",
          "values": [
            "<activityLogAlertResourceId>"
          ]
        },
        {
          "field": "AlertRuleName",
          "operator": "Equals",
          "values": [
            "<activityLogAlertResourceName>"
          ]
        },
        {
          "field": "Description",
          "operator": "Contains",
          "values": [
            "myAlertRuleDescription"
          ]
        },
        {
          "field": "MonitorService",
          "operator": "Equals",
          "values": [
            "ActivityLog Administrative"
          ]
        },
        {
          "field": "MonitorCondition",
          "operator": "Equals",
          "values": [
            "Fired"
          ]
        },
        {
          "field": "TargetResourceType",
          "operator": "DoesNotContain",
          "values": [
            "myAlertResourceType"
          ]
        },
        {
          "field": "TargetResource",
          "operator": "Equals",
          "values": [
            "myAlertResource1",
            "myAlertResource2"
          ]
        },
        {
          "field": "TargetResourceGroup",
          "operator": "Equals",
          "values": [
            "<id>"
          ]
        },
        {
          "field": "Severity",
          "operator": "Equals",
          "values": [
            "Sev0",
            "Sev1",
            "Sev2",
            "Sev3",
            "Sev4"
          ]
        },
        {
          "field": "SignalType",
          "operator": "Equals",
          "values": [
            "Health",
            "Log",
            "Metric",
            "Unknown"
          ]
        }
      ]
    },
    "enabled": {
      "value": true
    },
    "location": {
      "value": "<location>"
    },
    "lock": {
      "value": {
        "kind": "CanNotDelete",
        "name": "myCustomLockName"
      }
    },
    "roleAssignments": {
      "value": [
        {
          "name": "a66da6bc-b3ee-484e-9bdb-9294938bb327",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "Owner"
        },
        {
          "name": "<name>",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "b24988ac-6180-42a0-ab88-20f7382dd24c"
        },
        {
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "<roleDefinitionIdOrName>"
        }
      ]
    },
    "scopes": {
      "value": [
        "<id>"
      ]
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

via Bicep parameters file

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

// Required parameters
param name = 'aprmax001'
// Non-required parameters
param actions = [
  {
    actionGroupIds: [
      '<actionGroupResourceId>'
    ]
    actionType: 'AddActionGroups'
  }
]
param aprDescription = 'Test deployment of the module with the max set of parameters.'
param conditions = [
  {
    field: 'AlertContext'
    operator: 'NotEquals'
    values: [
      'myAlertContext'
    ]
  }
  {
    field: 'AlertRuleId'
    operator: 'Equals'
    values: [
      '<activityLogAlertResourceId>'
    ]
  }
  {
    field: 'AlertRuleName'
    operator: 'Equals'
    values: [
      '<activityLogAlertResourceName>'
    ]
  }
  {
    field: 'Description'
    operator: 'Contains'
    values: [
      'myAlertRuleDescription'
    ]
  }
  {
    field: 'MonitorService'
    operator: 'Equals'
    values: [
      'ActivityLog Administrative'
    ]
  }
  {
    field: 'MonitorCondition'
    operator: 'Equals'
    values: [
      'Fired'
    ]
  }
  {
    field: 'TargetResourceType'
    operator: 'DoesNotContain'
    values: [
      'myAlertResourceType'
    ]
  }
  {
    field: 'TargetResource'
    operator: 'Equals'
    values: [
      'myAlertResource1'
      'myAlertResource2'
    ]
  }
  {
    field: 'TargetResourceGroup'
    operator: 'Equals'
    values: [
      '<id>'
    ]
  }
  {
    field: 'Severity'
    operator: 'Equals'
    values: [
      'Sev0'
      'Sev1'
      'Sev2'
      'Sev3'
      'Sev4'
    ]
  }
  {
    field: 'SignalType'
    operator: 'Equals'
    values: [
      'Health'
      'Log'
      'Metric'
      'Unknown'
    ]
  }
]
param enabled = true
param location = '<location>'
param lock = {
  kind: 'CanNotDelete'
  name: 'myCustomLockName'
}
param roleAssignments = [
  {
    name: 'a66da6bc-b3ee-484e-9bdb-9294938bb327'
    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 scopes = [
  '<id>'
]
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 actionRule './packages/action-rules/main.bicep' = {
  name: 'actionRuleDeployment'
  params: {
    // Required parameters
    name: 'aprwaf001'
    // Non-required parameters
    actions: [
      {
        actionGroupIds: [
          '<actionGroupResourceId>'
        ]
        actionType: 'AddActionGroups'
      }
    ]
    aprDescription: 'Test deployment of the module with the waf aligned set of parameters.'
    location: '<location>'
    scopes: [
      '<id>'
    ]
  }
}

via JSON parameters file

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "aprwaf001"
    },
    // Non-required parameters
    "actions": {
      "value": [
        {
          "actionGroupIds": [
            "<actionGroupResourceId>"
          ],
          "actionType": "AddActionGroups"
        }
      ]
    },
    "aprDescription": {
      "value": "Test deployment of the module with the waf aligned set of parameters."
    },
    "location": {
      "value": "<location>"
    },
    "scopes": {
      "value": [
        "<id>"
      ]
    }
  }
}

via Bicep parameters file

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

// Required parameters
param name = 'aprwaf001'
// Non-required parameters
param actions = [
  {
    actionGroupIds: [
      '<actionGroupResourceId>'
    ]
    actionType: 'AddActionGroups'
  }
]
param aprDescription = 'Test deployment of the module with the waf aligned set of parameters.'
param location = '<location>'
param scopes = [
  '<id>'
]

Parameters

Required parameters

Parameter	Type	Description
`name`	string	Name of the alert processing rule.

Optional parameters

Parameter	Type	Description
`actions`	array	Actions to be applied.
`aprDescription`	string	Description of the alert processing rule.
`conditions`	array	Conditions on which alerts will be filtered.
`enabled`	bool	Indicates if the given alert processing rule is enabled or disabled.
`enableTelemetry`	bool	Enable/Disable usage telemetry for module.
`location`	string	Location for all resources.
`lock`	object	The lock settings of the service.
`roleAssignments`	array	Array of role assignments to create.
`schedule`	object	Scheduling for alert processing rule.
`scopes`	array	Scopes on which alert processing rule will apply.
`tags`	object	Resource tags.

Parameter: `name`

Name of the alert processing rule.

Required: Yes
Type: string

Parameter: `actions`

Actions to be applied.

Required: No
Type: array

Default:

[
  {
    actionType: 'RemoveAllActionGroups'
  }
]

Parameter: `aprDescription`

Description of the alert processing rule.

Required: No
Type: string
Default: ''

Parameter: `conditions`

Conditions on which alerts will be filtered.

Required: No
Type: array

Parameter: `enabled`

Indicates if the given alert processing rule is enabled or disabled.

Required: No
Type: bool
Default: True

Parameter: `enableTelemetry`

Enable/Disable usage telemetry for module.

Required: No
Type: bool
Default: True

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	Type	Description
`kind`	string	Specify the type of lock.
`name`	string	Specify the name of lock.

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

Scheduling for alert processing rule.

Required: No
Type: object

Parameter: `scopes`

Scopes on which alert processing rule will apply.

Required: No
Type: array
Default:
```
[
  '[subscription().id]'
]
```

Parameter: `tags`

Resource tags.

Required: No
Type: object

Outputs

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

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-rules",
      "version": "0.2.2"
    }
  ]
}

avm-bicep/utl-common-types:0.5.1

Stats

Selected version:

0.2.2

Downloads this version:

Downloads all versions:

Latest version:

0.2.2

Latest update:

10-04-2025

avm-bicep

Other versions (2)

0.2.2

0.2.0

Other packages

from avm-bicep

aad-domain-services

action-groups

action-rules

View all from publisher

Kickstart your project with AVM templates.

Report Package action-rules

Action Rules [Microsoft.AlertsManagement/actionRules]

Navigation

Resource Types

Usage examples

Example 1: Using small parameter set

Example 2: Using large parameter set

Example 3: WAF-aligned

Parameters

Parameter: name

Parameter: actions

Parameter: aprDescription

Parameter: conditions

Parameter: enabled

Parameter: enableTelemetry

Parameter: location

Parameter: lock

Parameter: lock.kind

Parameter: lock.name

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: schedule

Parameter: scopes

Parameter: tags

Outputs

Cross-referenced modules

Data Collection

Stats

avm-bicep

Other versions (2)

Other packages

from avm-bicep

Action Rules `[Microsoft.AlertsManagement/actionRules]`

Parameter: `name`

Parameter: `actions`

Parameter: `aprDescription`

Parameter: `conditions`

Parameter: `enabled`

Parameter: `enableTelemetry`

Parameter: `location`

Parameter: `lock`

Parameter: `lock.kind`

Parameter: `lock.name`

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

Parameter: `scopes`

Parameter: `tags`