Kickstart your project with AVM templates.

activity-log-alerts

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 Activity Log Alert.

ipm add --package avm-bicep/activity-log-alerts --version 0.3.1

Published: 08-02-2025

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

Package Type: Bicep

License: MIT

Activity Log Alerts `[Microsoft.Insights/activityLogAlerts]`

This module deploys an Activity Log Alert.

Resource Types

Resource Type	API Version
`Microsoft.Authorization/roleAssignments`	2022-04-01
`Microsoft.Insights/activityLogAlerts`	2020-10-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/activity-log-alerts/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 activityLogAlert './packages/activity-log-alerts/main.bicep' = {
  name: 'activityLogAlertDeployment'
  params: {
    // Required parameters
    conditions: [
      {
        equals: 'ServiceHealth'
        field: 'category'
      }
      {
        anyOf: [
          {
            equals: 'Incident'
            field: 'properties.incidentType'
          }
          {
            equals: 'Maintenance'
            field: 'properties.incidentType'
          }
        ]
      }
      {
        containsAny: [
          'Storage'
        ]
        field: 'properties.impactedServices[*].ServiceName'
      }
      {
        containsAny: [
          'West Europe'
        ]
        field: 'properties.impactedServices[*].ImpactedRegions[*].RegionName'
      }
    ]
    name: 'ialamin001'
    // 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
    "conditions": {
      "value": [
        {
          "equals": "ServiceHealth",
          "field": "category"
        },
        {
          "anyOf": [
            {
              "equals": "Incident",
              "field": "properties.incidentType"
            },
            {
              "equals": "Maintenance",
              "field": "properties.incidentType"
            }
          ]
        },
        {
          "containsAny": [
            "Storage"
          ],
          "field": "properties.impactedServices[*].ServiceName"
        },
        {
          "containsAny": [
            "West Europe"
          ],
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName"
        }
      ]
    },
    "name": {
      "value": "ialamin001"
    },
    // Non-required parameters
    "location": {
      "value": "global"
    }
  }
}

via Bicep parameters file

using './packages/activity-log-alerts/main.bicep'

// Required parameters
param conditions = [
  {
    equals: 'ServiceHealth'
    field: 'category'
  }
  {
    anyOf: [
      {
        equals: 'Incident'
        field: 'properties.incidentType'
      }
      {
        equals: 'Maintenance'
        field: 'properties.incidentType'
      }
    ]
  }
  {
    containsAny: [
      'Storage'
    ]
    field: 'properties.impactedServices[*].ServiceName'
  }
  {
    containsAny: [
      'West Europe'
    ]
    field: 'properties.impactedServices[*].ImpactedRegions[*].RegionName'
  }
]
param name = 'ialamin001'
// 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 activityLogAlert './packages/activity-log-alerts/main.bicep' = {
  name: 'activityLogAlertDeployment'
  params: {
    // Required parameters
    conditions: [
      {
        equals: 'ServiceHealth'
        field: 'category'
      }
      {
        anyOf: [
          {
            equals: 'Incident'
            field: 'properties.incidentType'
          }
          {
            equals: 'Maintenance'
            field: 'properties.incidentType'
          }
        ]
      }
      {
        containsAny: [
          'Action Groups'
          'Activity Logs & Alerts'
        ]
        field: 'properties.impactedServices[*].ServiceName'
      }
      {
        containsAny: [
          'Global'
          'West Europe'
        ]
        field: 'properties.impactedServices[*].ImpactedRegions[*].RegionName'
      }
    ]
    name: 'ialamax001'
    // Non-required parameters
    actions: [
      {
        actionGroupId: '<actionGroupId>'
      }
    ]
    location: 'global'
    roleAssignments: [
      {
        name: 'be96d7a9-6596-40c7-9acd-db6acd5cd41b'
        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
    "conditions": {
      "value": [
        {
          "equals": "ServiceHealth",
          "field": "category"
        },
        {
          "anyOf": [
            {
              "equals": "Incident",
              "field": "properties.incidentType"
            },
            {
              "equals": "Maintenance",
              "field": "properties.incidentType"
            }
          ]
        },
        {
          "containsAny": [
            "Action Groups",
            "Activity Logs & Alerts"
          ],
          "field": "properties.impactedServices[*].ServiceName"
        },
        {
          "containsAny": [
            "Global",
            "West Europe"
          ],
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName"
        }
      ]
    },
    "name": {
      "value": "ialamax001"
    },
    // Non-required parameters
    "actions": {
      "value": [
        {
          "actionGroupId": "<actionGroupId>"
        }
      ]
    },
    "location": {
      "value": "global"
    },
    "roleAssignments": {
      "value": [
        {
          "name": "be96d7a9-6596-40c7-9acd-db6acd5cd41b",
          "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/activity-log-alerts/main.bicep'

// Required parameters
param conditions = [
  {
    equals: 'ServiceHealth'
    field: 'category'
  }
  {
    anyOf: [
      {
        equals: 'Incident'
        field: 'properties.incidentType'
      }
      {
        equals: 'Maintenance'
        field: 'properties.incidentType'
      }
    ]
  }
  {
    containsAny: [
      'Action Groups'
      'Activity Logs & Alerts'
    ]
    field: 'properties.impactedServices[*].ServiceName'
  }
  {
    containsAny: [
      'Global'
      'West Europe'
    ]
    field: 'properties.impactedServices[*].ImpactedRegions[*].RegionName'
  }
]
param name = 'ialamax001'
// Non-required parameters
param actions = [
  {
    actionGroupId: '<actionGroupId>'
  }
]
param location = 'global'
param roleAssignments = [
  {
    name: 'be96d7a9-6596-40c7-9acd-db6acd5cd41b'
    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 activityLogAlert './packages/activity-log-alerts/main.bicep' = {
  name: 'activityLogAlertDeployment'
  params: {
    // Required parameters
    conditions: [
      {
        equals: 'ServiceHealth'
        field: 'category'
      }
      {
        anyOf: [
          {
            equals: 'Incident'
            field: 'properties.incidentType'
          }
          {
            equals: 'Maintenance'
            field: 'properties.incidentType'
          }
        ]
      }
      {
        containsAny: [
          'Action Groups'
          'Activity Logs & Alerts'
        ]
        field: 'properties.impactedServices[*].ServiceName'
      }
      {
        containsAny: [
          'Global'
          'West Europe'
        ]
        field: 'properties.impactedServices[*].ImpactedRegions[*].RegionName'
      }
    ]
    name: 'ialawaf001'
    // Non-required parameters
    actions: [
      {
        actionGroupId: '<actionGroupId>'
      }
    ]
    location: 'global'
    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
    "conditions": {
      "value": [
        {
          "equals": "ServiceHealth",
          "field": "category"
        },
        {
          "anyOf": [
            {
              "equals": "Incident",
              "field": "properties.incidentType"
            },
            {
              "equals": "Maintenance",
              "field": "properties.incidentType"
            }
          ]
        },
        {
          "containsAny": [
            "Action Groups",
            "Activity Logs & Alerts"
          ],
          "field": "properties.impactedServices[*].ServiceName"
        },
        {
          "containsAny": [
            "Global",
            "West Europe"
          ],
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName"
        }
      ]
    },
    "name": {
      "value": "ialawaf001"
    },
    // Non-required parameters
    "actions": {
      "value": [
        {
          "actionGroupId": "<actionGroupId>"
        }
      ]
    },
    "location": {
      "value": "global"
    },
    "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/activity-log-alerts/main.bicep'

// Required parameters
param conditions = [
  {
    equals: 'ServiceHealth'
    field: 'category'
  }
  {
    anyOf: [
      {
        equals: 'Incident'
        field: 'properties.incidentType'
      }
      {
        equals: 'Maintenance'
        field: 'properties.incidentType'
      }
    ]
  }
  {
    containsAny: [
      'Action Groups'
      'Activity Logs & Alerts'
    ]
    field: 'properties.impactedServices[*].ServiceName'
  }
  {
    containsAny: [
      'Global'
      'West Europe'
    ]
    field: 'properties.impactedServices[*].ImpactedRegions[*].RegionName'
  }
]
param name = 'ialawaf001'
// Non-required parameters
param actions = [
  {
    actionGroupId: '<actionGroupId>'
  }
]
param location = 'global'
param scopes = [
  '<id>'
]
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Parameters

Required parameters

Parameter	Type	Description
`conditions`	array	An Array of objects containing conditions that will cause this alert to activate. Conditions can also be combined with logical operators `allOf` and `anyOf`. Each condition can specify only one field between `equals` and `containsAny`. An alert rule condition must have exactly one category (Administrative, ServiceHealth, ResourceHealth, Alert, Autoscale, Recommendation, Security, or Policy).
`name`	string	The name of the alert.

Optional parameters

Parameter	Type	Description
`actions`	array	The list of actions to take when alert triggers.
`alertDescription`	string	Description of the alert.
`enabled`	bool	Indicates whether this alert is enabled.
`enableTelemetry`	bool	Enable/Disable usage telemetry for module.
`location`	string	Location for all resources.
`roleAssignments`	array	Array of role assignments to create.
`scopes`	array	The list of resource IDs that this Activity Log Alert is scoped to.
`tags`	object	Tags of the resource.

Parameter: `conditions`

An Array of objects containing conditions that will cause this alert to activate. Conditions can also be combined with logical operators allOf and anyOf. Each condition can specify only one field between equals and containsAny. An alert rule condition must have exactly one category (Administrative, ServiceHealth, ResourceHealth, Alert, Autoscale, Recommendation, Security, or Policy).

Required: Yes
Type: array

Parameter: `name`

The name of the alert.

Required: Yes
Type: string

Parameter: `actions`

The list of actions to take when alert triggers.

Required: No
Type: array
Default: []

Parameter: `alertDescription`

Description of the alert.

Required: No
Type: string
Default: ''

Parameter: `enabled`

Indicates whether this alert is enabled.

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

The list of resource IDs that this Activity Log Alert is scoped to.

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

Parameter: `tags`

Tags of the resource.

Required: No
Type: object

Outputs

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

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/activity-log-alerts",
      "version": "0.3.1"
    }
  ]
}

avm-bicep/utl-common-types:0.5.1

Stats

Selected version:

0.3.1

Downloads this version:

Downloads all versions:

Latest version:

0.3.1

Latest update:

08-02-2025

avm-bicep

Other versions (2)

0.3.1

0.3.0

Other packages

from avm-bicep

action-groups

action-rules

aad-domain-services

View all from publisher

Kickstart your project with AVM templates.

Report Package activity-log-alerts

Activity Log Alerts [Microsoft.Insights/activityLogAlerts]

Navigation

Resource Types

Usage examples

Example 1: Using only defaults

Example 2: Using large parameter set

Example 3: WAF-aligned

Parameters

Parameter: conditions

Parameter: name

Parameter: actions

Parameter: alertDescription

Parameter: enabled

Parameter: enableTelemetry

Parameter: location

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

Parameter: tags

Outputs

Cross-referenced modules

Data Collection

Stats

avm-bicep

Other versions (2)

Other packages

from avm-bicep

Activity Log Alerts `[Microsoft.Insights/activityLogAlerts]`

Parameter: `conditions`

Parameter: `name`

Parameter: `actions`

Parameter: `alertDescription`

Parameter: `enabled`

Parameter: `enableTelemetry`

Parameter: `location`

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

Parameter: `tags`