AlertRuleProperties interface

An Azure Activity Log Alert rule.

Properties

actions

The actions that will activate when the condition is met.

condition

The condition that will cause this alert to activate.

description

A description of this Activity Log Alert rule.

enabled

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.

scopes

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.

tenantScope

The tenant GUID. Must be provided for tenant-level and management group events rules.

Property Details

actions

The actions that will activate when the condition is met.

actions: ActionList

Property Value

condition

The condition that will cause this alert to activate.

condition: AlertRuleAllOfCondition

Property Value

description

A description of this Activity Log Alert rule.

description?: string

Property Value

string

enabled

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.

enabled?: boolean

Property Value

boolean

scopes

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.

scopes?: string[]

Property Value

string[]

tenantScope

The tenant GUID. Must be provided for tenant-level and management group events rules.

tenantScope?: string

Property Value

string