Bicep Module Documentation

← Back to Overview

Module activity-log-alert

activityLogAlert

Property Value Description
general (required) general
AlertRuleAllOfCondition (required) AlertRuleAllOfCondition[]
actionGroup (required) actionGroup
scopes (required) string[] A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item.

AlertRuleAllOfCondition

Property Value Description
field (required) 'caller'
'category'
'level'
'operationName'
'properties'
'resourceGroup'
'resourceId'
'resourceProvider'
'resourceType'
'status'
'subStatus'
The name of the Activity Log event field that this condition will examine.
equals string The value of the event field will be compared to this value (case-insensitive) to determine if the condition is met
containsAny string[] The value of the event field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

emailReceivers

Property Value Description
emailAddress (required) string The email address of this receiver.
name (required) string The name of the email receiver. Names must be unique across all receivers within an action group.
useCommonAlertSchema (required) bool Indicates whether to use common alert schema.

actionGroup

Property Value Description
enabled bool Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated. (default: true)
groupShortName (required) string The short name of the action group. This will be used in SMS messages.
emailReceivers emailReceivers[] The list of email receivers that are part of this action group.

naming

Property Value Description
forceFunctionAsFullName bool Use the function value as the full name of the resource
abbreviation string Override the abbreviation of this resource with this parameter
environment string The resource environment (for example: dev, tst, acc, prd)
location string The resource location (for example: weu, we, westeurope)
customer string The name of the customer
delimiter string The delimiter between resources (default: -)
nameFormat Array containing any of:
'abbreviation'
'customer'
'environment'
'function'
'location'
'param1'
'param2'
'param3'
'useCaseName'
The order of the array defines the order of elements in the naming scheme
param1 string Extra parameter self defined
param2 string Extra parameter self defined
param3 string Extra parameter self defined
function (required) string Function of the resource [can be app, db, security,...]
useCaseName string Name of the use case [can be hub, spoke,...]
suffix string Suffix for the resource, if empty non will be appended, otherwise will be added to the end [can be index, ...]
forceDefaultNaming bool Force the CAF naming instead of default company naming

resourceLock

Property Value Description
name string Character limit: 1-90. Valid characters: Alphanumerics, periods, underscores, hyphens, and parenthesis. Can't end in period.
level (required) 'CanNotDelete'
'ReadOnly'
The level of the lock. Possible values are: CanNotDelete and ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. Read-Only locks must be commented to be able to deploy again
notes string Notes about the lock. Maximum of 512 characters.
owners resourceLockOwner[] The owners of the lock

resourceLockOwner

Property Value Description
applicationId (required) string The application ID of the lock owner.

roleAssignment

Property Value Description
principalId (required) string The principal ID
roleDefinitionId (required) string The role definition ID, data file can be used for this
condition string Condition on the role assignment
conditionVersion string Version of the condition. Currently the only accepted value is "2.0"
delegatedManagedIdentityResourceId string Id of the delegated managed identity resource
description string Description of role assignment

general

Property Value Description
tags object Tags of the resource [hashtable]
location (required) string Location of the resource
naming (required) naming Naming module of the resource
resourceGroupName (required) string Name of the resource group where the resource should be located
sharedNaming (required) naming Reference to the default naming
roleAssignments roleAssignment[] Role assignments on the resource
resourceLocks resourceLock[] Resource Locks on the resource

Changelog

2.0.1 (2025-09-24)

Bug Fixes

  • remove deployment name + cleanup

2.0.0 (2025-09-24)

⚠ BREAKING CHANGES

  • remove deprecated outputs

Bug Fixes

  • remove deprecated outputs

1.1.1 (2025-02-28)

Bug Fixes

  • revise descriptions

1.1.0 (2024-12-16)

Features

  • hele nieuwe feature