Microsoft.Insights scheduledQueryRules 2018-04-16

Article
12/09/2024

Remarks

For guidance on deploying monitoring solutions, see Create monitoring resources by using Bicep.

Bicep resource definition

The scheduledQueryRules 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/scheduledQueryRules resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2018-04-16' = {
  location: 'string'
  name: 'string'
  properties: {
    action: {
      odata.type: 'string'
      // For remaining properties, see Action objects
    }
    autoMitigate: bool
    description: 'string'
    displayName: 'string'
    enabled: 'string'
    schedule: {
      frequencyInMinutes: int
      timeWindowInMinutes: int
    }
    source: {
      authorizedResources: [
        'string'
      ]
      dataSourceId: 'string'
      query: 'string'
      queryType: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Action objects

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

For Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, use:

{
  aznsAction: {
    actionGroup: [
      'string'
    ]
    customWebhookPayload: 'string'
    emailSubject: 'string'
  }
  odata.type: 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
  severity: 'string'
  throttlingInMin: int
  trigger: {
    metricTrigger: {
      metricColumn: 'string'
      metricTriggerType: 'string'
      threshold: int
      thresholdOperator: 'string'
    }
    threshold: int
    thresholdOperator: 'string'
  }
}

For Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, use:

{
  criteria: [
    {
      dimensions: [
        {
          name: 'string'
          operator: 'string'
          values: [
            'string'
          ]
        }
      ]
      metricName: 'string'
    }
  ]
  odata.type: 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction'
}

Property Values

Action

Name	Description	Value
odata.type	Set to 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' for type AlertingAction. Set to 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' for type LogToMetricAction.	'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (required)

AlertingAction

Name	Description	Value
aznsAction	Azure action group reference.	AzNsActionGroup
odata.type	Specifies the action. Supported values - AlertingAction, LogToMetricAction	'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' (required)
severity	Severity of the alert	'0' '1' '2' '3' '4' (required)
throttlingInMin	time (in minutes) for which Alerts should be throttled or suppressed.	int
trigger	The trigger condition that results in the alert rule being.	TriggerCondition (required)

AzNsActionGroup

Name	Description	Value
actionGroup	Azure Action Group reference.	string[]
customWebhookPayload	Custom payload to be sent for all webhook URI in Azure action group	string
emailSubject	Custom subject override for all email ids in Azure action group	string

Criteria

Name	Description	Value
dimensions	List of Dimensions for creating metric	Dimension[]
metricName	Name of the metric	string (required)

Dimension

Name	Description	Value
name	Name of the dimension	string (required)
operator	Operator for dimension values	'Include' (required)
values	List of dimension values	string[] (required)

LogMetricTrigger

Name	Description	Value
metricColumn	Evaluation of metric on a particular column	string
metricTriggerType	Metric Trigger Type - 'Consecutive' or 'Total'	'Consecutive' 'Total'
threshold	The threshold of the metric trigger.	int
thresholdOperator	Evaluation operation for Metric -'GreaterThan' or 'LessThan' or 'Equal'.	'Equal' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual'

LogSearchRule

Name	Description	Value
action	Action needs to be taken on rule execution.	Action (required)
autoMitigate	The flag that indicates whether the alert should be automatically resolved or not. The default is false.	bool
description	The description of the Log Search rule.	string
displayName	The display name of the alert rule	string
enabled	The flag which indicates whether the Log Search rule is enabled. Value should be true or false	'false' 'true'
schedule	Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction	Schedule
source	Data Source against which rule will Query Data	Source (required)

LogToMetricAction

Name	Description	Value
criteria	Criteria of Metric	Criteria[] (required)
odata.type	Specifies the action. Supported values - AlertingAction, LogToMetricAction	'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (required)