Microsoft.Insights alertrules

2024-12-09

Bicep resource definition

The alertrules resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Insights/alertrules resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Insights/alertrules@2016-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    action: {
      odata.type: 'string'
      // For remaining properties, see RuleAction objects
    }
    actions: [
      {
        odata.type: 'string'
        // For remaining properties, see RuleAction objects
      }
    ]
    condition: {
      dataSource: {
        legacyResourceId: 'string'
        metricNamespace: 'string'
        resourceLocation: 'string'
        resourceUri: 'string'
        odata.type: 'string'
        // For remaining properties, see RuleDataSource objects
      }
      odata.type: 'string'
      // For remaining properties, see RuleCondition objects
    }
    description: 'string'
    isEnabled: bool
    name: 'string'
    provisioningState: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

RuleAction objects

Set the odata.type property to specify the type of object.

For Microsoft.Azure.Management.Insights.Models.RuleEmailAction, use:

{
  customEmails: [
    'string'
  ]
  odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleEmailAction'
  sendToServiceOwners: bool
}

For Microsoft.Azure.Management.Insights.Models.RuleWebhookAction, use:

{
  odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleWebhookAction'
  properties: {
    {customized property}: 'string'
  }
  serviceUri: 'string'
}

RuleDataSource objects

Set the odata.type property to specify the type of object.

For Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource, use:

{
  claims: {
    emailAddress: 'string'
  }
  eventName: 'string'
  eventSource: 'string'
  level: 'string'
  odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource'
  operationName: 'string'
  resourceGroupName: 'string'
  resourceProviderName: 'string'
  status: 'string'
  subStatus: 'string'
}

For Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource, use:

{
  metricName: 'string'
  odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource'
}

RuleCondition objects

Set the odata.type property to specify the type of object.

For Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition, use:

{
  failedLocationCount: int
  odata.type: 'Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition'
  windowSize: 'string'
}

For Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition, use:

{
  aggregation: {
    operator: 'string'
    threshold: int
    windowSize: 'string'
  }
  odata.type: 'Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition'
}

For Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition, use:

{
  odata.type: 'Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition'
  operator: 'string'
  threshold: int
  timeAggregation: 'string'
  windowSize: 'string'
}

Property values

AlertRule

Name	Description	Value
action	action that is performed when the alert rule becomes active, and when an alert condition is resolved.	RuleAction
actions	the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.	RuleAction[]
condition	the condition that results in the alert rule being activated.	RuleCondition (required)
description	the description of the alert rule that will be included in the alert email.	string
isEnabled	the flag that indicates whether the alert rule is enabled.	bool (required)
name	the name of the alert rule.	string (required)
provisioningState	the provisioning state.	string

LocationThresholdRuleCondition

Name	Description	Value
failedLocationCount	the number of locations that must fail to activate the alert.	int Constraints: Min value = 0 (required)
odata.type	specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric).	'Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition' (required)
windowSize	the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.	string

ManagementEventAggregationCondition

Name	Description	Value
operator	the condition operator.	'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual'
threshold	The threshold value that activates the alert.	int
windowSize	the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.	string

ManagementEventRuleCondition

Name	Description	Value
aggregation	How the data that is collected should be combined over time and when the alert is activated. Note that for management event alerts aggregation is optional – if it is not provided then any event will cause the alert to activate.	ManagementEventAggregationCondition
odata.type	specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric).	'Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition' (required)