你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Insights scheduledQueryRules

项目
09/21/2023

Bicep 资源定义

scheduledQueryRules 资源类型可以使用目标操作进行部署：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

注解

有关部署监视解决方案的指南，请参阅使用 Bicep 创建监视资源。

资源格式

若要创建 Microsoft.Insights/scheduledQueryRules 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2023-03-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    actions: {
      actionGroups: [
        'string'
      ]
      actionProperties: {}
      customProperties: {}
    }
    autoMitigate: bool
    checkWorkspaceAlertsStorageConfigured: bool
    criteria: {
      allOf: [
        {
          dimensions: [
            {
              name: 'string'
              operator: 'string'
              values: [
                'string'
              ]
            }
          ]
          failingPeriods: {
            minFailingPeriodsToAlert: int
            numberOfEvaluationPeriods: int
          }
          metricMeasureColumn: 'string'
          metricName: 'string'
          operator: 'string'
          query: 'string'
          resourceIdColumn: 'string'
          threshold: int
          timeAggregation: 'string'
        }
      ]
    }
    description: 'string'
    displayName: 'string'
    enabled: bool
    evaluationFrequency: 'string'
    muteActionsDuration: 'string'
    overrideQueryTimeRange: 'string'
    ruleResolveConfiguration: {
      autoResolved: bool
      timeToResolve: 'string'
    }
    scopes: [
      'string'
    ]
    severity: int
    skipQueryValidation: bool
    targetResourceTypes: [
      'string'
    ]
    windowSize: 'string'
  }
}

属性值

scheduledQueryRules

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：1-260 有效字符：不得使用： `*<>%{}&:\\?/#` 或控制字符不得以空格或句点结尾。
location	资源所在的地理位置	字符串 (必需)
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
kind	指示计划查询规则的类型。默认值为 LogAlert。	“LogAlert” “LogToMetric”
标识	资源的标识。	标识
properties	资源的规则属性。	ScheduledQueryRuleProperties (必需)

标识

名称	说明	Value
type	托管服务标识的类型。	“None” “SystemAssigned” “UserAssigned” (必需)
userAssignedIdentities	与资源关联的用户标识列表。用户标识字典密钥引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	对象 (object)

ScheduledQueryRuleProperties

名称	说明	值
actions	触发警报时要调用的操作。	操作
autoMitigate	指示是否应自动解决警报的标志。默认值为 true。仅与 LogAlert 类型的规则相关。	bool
checkWorkspaceAlertsStorageConfigured	指示此计划查询规则是否应存储在客户的存储中的标志。默认值为 false。仅与 LogAlert 类型的规则相关。	bool
条件	定义计划查询规则条件的规则条件。	ScheduledQueryRuleCriteria
description	计划查询规则的说明。	字符串
displayName	警报规则的显示名称	字符串
enabled	指示是否启用此计划查询规则的标志。值应为 true 或 false	bool
evaluationFrequency	以 ISO 8601 持续时间格式表示的计划查询规则的计算频率。仅对 LogAlert 类型的规则相关且是必需的。	字符串
muteActionsDuration	触发警报后，) 以 ISO 8601 持续时间格式将所选时间段的操作 (静音。仅适用于 LogAlert 类型的规则。	字符串
overrideQueryTimeRange	如果指定，则替代查询时间范围， (默认值为 WindowSize*NumberOfEvaluationPeriods) 。仅适用于 LogAlert 类型的规则。	字符串
ruleResolveConfiguration	定义用于解决触发的警报的配置。仅适用于 LogAlert 类型的规则。	RuleResolveConfiguration
范围	此计划查询规则的作用域为的资源 ID 的列表。	string[]
severity	警报的严重性。应为 [0-4] 之间的整数。值 0 最严重。仅适用于 LogAlert 类型的规则的相关和必需项。	int
skipQueryValidation	指示是否应验证提供的查询的标志。默认值为 false。仅适用于 LogAlert 类型的规则。	bool
targetResourceTypes	创建/更新警报的目标资源 () 的资源类型列表。例如，如果范围是资源组，targetResourceTypes 是 Microsoft.Compute/virtualMachines，则会针对资源组中满足警报条件的每个虚拟机触发不同的警报。仅适用于 LogAlert 类型的规则	string[]
windowSize	以 ISO 8601 持续时间格式 (的时间段) ，将在其中执行警报查询 (箱大小) 。仅适用于 LogAlert 类型的规则的相关和必需项。	字符串

“操作”

名称	说明	值
actionGroups	触发警报时要调用的操作组资源 ID。	string[]
actionProperties	操作属性的属性。	对象 (object)
customProperties	警报有效负载的属性。	对象 (object)

ScheduledQueryRuleCriteria

名称	说明	值
allOf	要针对指定范围评估的条件列表	Condition[]

条件

名称	说明	值
dimensions	维度条件列表	Dimension[]
failingPeriods	在所选回溯时间范围内引发警报所需的最小冲突数。仅适用于 LogAlert 类型的规则。	ConditionFailingPeriods
metricMeasureColumn	包含指标度量值编号的列。仅适用于 LogAlert 类型的规则。	字符串
metricName	要发送的指标的名称。仅适用于 LogToMetric 类型的规则的相关和必需项。	字符串
运算符后的表达式	criteria 运算符。仅适用于 LogAlert 类型的规则的相关和必需项。	'Equals' “GreaterThan” “GreaterThanOrEqual” “LessThan” “LessThanOrEqual”
query	日志查询警报	字符串
resourceIdColumn	包含资源 ID 的列。列的内容必须是格式为资源 ID 的 URI。仅适用于 LogAlert 类型的规则。	字符串
阈值	激活警报的条件阈值。仅适用于 LogAlert 类型的规则的相关和必需项。	int
timeAggregation	聚合类型。仅适用于 LogAlert 类型的规则的相关和必需项。	'Average' 'Count' “Maximum” “Minimum” “Total”

维度

名称	说明	值
name	维度的名称	字符串 (必需)
运算符后的表达式	维度值的运算符	“排除” “Include” (必需)
值	维度值列表	string[] (必需的)

ConditionFailingPeriods

名称	说明	值
minFailingPeriodsToAlert	触发警报的冲突数。应小于或等于 numberOfEvaluationPeriods。默认值为 1	int
numberOfEvaluationPeriods	聚合的回溯点数。回溯时间窗口是根据聚合粒度 (windowSize) 和所选聚合点数计算的。默认值为 1	int

RuleResolveConfiguration

名称	说明	值
autoResolved	指示是否自动解决触发的警报的标志。	bool
timeToResolve	在自动解决触发的警报之前，规则必须评估为正常状态的持续时间，以 ISO 8601 持续时间格式表示。	字符串

ARM 模板资源定义

scheduledQueryRules 资源类型可以使用目标操作进行部署：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

注解

有关部署监视解决方案的指南，请参阅使用 Bicep 创建监视资源。

资源格式

若要创建 Microsoft.Insights/scheduledQueryRules 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2023-03-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "actions": {
      "actionGroups": [ "string" ],
      "actionProperties": {},
      "customProperties": {}
    },
    "autoMitigate": "bool",
    "checkWorkspaceAlertsStorageConfigured": "bool",
    "criteria": {
      "allOf": [
        {
          "dimensions": [
            {
              "name": "string",
              "operator": "string",
              "values": [ "string" ]
            }
          ],
          "failingPeriods": {
            "minFailingPeriodsToAlert": "int",
            "numberOfEvaluationPeriods": "int"
          },
          "metricMeasureColumn": "string",
          "metricName": "string",
          "operator": "string",
          "query": "string",
          "resourceIdColumn": "string",
          "threshold": "int",
          "timeAggregation": "string"
        }
      ]
    },
    "description": "string",
    "displayName": "string",
    "enabled": "bool",
    "evaluationFrequency": "string",
    "muteActionsDuration": "string",
    "overrideQueryTimeRange": "string",
    "ruleResolveConfiguration": {
      "autoResolved": "bool",
      "timeToResolve": "string"
    },
    "scopes": [ "string" ],
    "severity": "int",
    "skipQueryValidation": "bool",
    "targetResourceTypes": [ "string" ],
    "windowSize": "string"
  }
}

属性值

scheduledQueryRules

名称	说明	Value
type	资源类型	“Microsoft.Insights/scheduledQueryRules”
apiVersion	资源 API 版本	“2023-03-15-preview”
name	资源名称	字符串 (必需) 字符限制：1-260 有效字符：不得使用： `*<>%{}&:\\?/#` 或控制字符不得以空格或句点结尾。
location	资源所在的地理位置	字符串 (必需)
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
kind	指示计划查询规则的类型。默认值为 LogAlert。	“LogAlert” “LogToMetric”
标识	资源的标识。	标识
properties	资源的规则属性。	ScheduledQueryRuleProperties (必需)

标识

名称	说明	Value
type	托管服务标识的类型。	“None” “SystemAssigned” “UserAssigned” (必需)
userAssignedIdentities	与资源关联的用户标识列表。用户标识字典密钥引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	对象 (object)

ScheduledQueryRuleProperties

名称	说明	值
actions	触发警报时要调用的操作。	操作
autoMitigate	指示是否应自动解决警报的标志。默认值为 true。仅适用于 LogAlert 类型的规则。	bool
checkWorkspaceAlertsStorageConfigured	指示是否应将此计划查询规则存储在客户的存储中的标志。默认值为 false。仅适用于 LogAlert 类型的规则。	bool
条件	定义计划查询规则的条件的规则条件。	ScheduledQueryRuleCriteria
description	计划查询规则的说明。	字符串
displayName	警报规则的显示名称	字符串
enabled	指示是否启用此计划查询规则的标志。值应为 true 或 false	bool
evaluationFrequency	以 ISO 8601 持续时间格式表示的计划查询规则的计算频率。仅适用于 LogAlert 类型的规则的相关和必需项。	字符串
muteActionsDuration	触发警报后，将所选时间段的操作静音 (ISO 8601 持续时间格式) 。仅适用于 LogAlert 类型的规则。	字符串
overrideQueryTimeRange	如果指定，则替代查询时间范围， (默认值为 WindowSize*NumberOfEvaluationPeriods) 。仅适用于 LogAlert 类型的规则。	字符串
ruleResolveConfiguration	定义用于解决触发的警报的配置。仅适用于 LogAlert 类型的规则。	RuleResolveConfiguration
范围	此计划查询规则的作用域为的资源 ID 的列表。	string[]
severity	警报的严重性。应为 [0-4] 之间的整数。值 0 最严重。仅适用于 LogAlert 类型的规则的相关和必需项。	int
skipQueryValidation	指示是否应验证提供的查询的标志。默认值为 false。仅适用于 LogAlert 类型的规则。	bool
targetResourceTypes	创建/更新警报的目标资源 () 的资源类型列表。例如，如果范围是资源组，targetResourceTypes 是 Microsoft.Compute/virtualMachines，则会针对资源组中满足警报条件的每个虚拟机触发不同的警报。仅适用于 LogAlert 类型的规则	string[]
windowSize	以 ISO 8601 持续时间格式 (的时间段) ，将在其中执行警报查询 (箱大小) 。仅适用于 LogAlert 类型的规则的相关和必需项。	字符串

“操作”

名称	说明	值
actionGroups	触发警报时要调用的操作组资源 ID。	string[]
actionProperties	操作属性的属性。	对象 (object)
customProperties	警报有效负载的属性。	对象 (object)

ScheduledQueryRuleCriteria

名称	说明	值
allOf	要针对指定范围评估的条件列表	Condition[]

条件

名称	说明	值
dimensions	维度条件列表	Dimension[]
failingPeriods	在所选回溯时间范围内引发警报所需的最小冲突数。仅适用于 LogAlert 类型的规则。	ConditionFailingPeriods
metricMeasureColumn	包含指标度量值编号的列。仅适用于 LogAlert 类型的规则。	字符串
metricName	要发送的指标的名称。仅对类型 LogToMetric 的规则相关且是必需的。	字符串
运算符后的表达式	criteria 运算符。仅对 LogAlert 类型的规则相关且是必需的。	“Equals” “GreaterThan” “GreaterThanOrEqual” “LessThan” “LessThanOrEqual”
query	日志查询警报	字符串
resourceIdColumn	包含资源 ID 的列。列的内容必须是格式为资源 ID 的 URI。仅与 LogAlert 类型的规则相关。	字符串
阈值	激活警报的条件阈值。仅对 LogAlert 类型的规则相关且是必需的。	int
timeAggregation	聚合类型。仅对 LogAlert 类型的规则相关且是必需的。	“平均” “Count” “Maximum” “Minimum” “Total”

维度

名称	说明	值
name	维度的名称	字符串 (必需)
运算符后的表达式	维度值的运算符	“排除” “Include” (必需)
值	维度值列表	string[] (必需的)

ConditionFailingPeriods

名称	说明	值
minFailingPeriodsToAlert	触发警报的冲突数。应小于或等于 numberOfEvaluationPeriods。默认值为 1	int
numberOfEvaluationPeriods	聚合的回溯点数。回溯时间窗口是根据聚合粒度 (windowSize) 和所选聚合点数计算的。默认值为 1	int

RuleResolveConfiguration

名称	说明	值
autoResolved	指示是否自动解决触发的警报的标志。	bool
timeToResolve	在自动解决触发的警报之前，规则必须评估为正常状态的持续时间，以 ISO 8601 持续时间格式表示。	字符串

Terraform (AzAPI 提供程序) 资源定义

scheduledQueryRules 资源类型可以使用目标操作进行部署：

资源组

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Insights/scheduledQueryRules 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2023-03-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      actions = {
        actionGroups = [
          "string"
        ]
        actionProperties = {}
        customProperties = {}
      }
      autoMitigate = bool
      checkWorkspaceAlertsStorageConfigured = bool
      criteria = {
        allOf = [
          {
            dimensions = [
              {
                name = "string"
                operator = "string"
                values = [
                  "string"
                ]
              }
            ]
            failingPeriods = {
              minFailingPeriodsToAlert = int
              numberOfEvaluationPeriods = int
            }
            metricMeasureColumn = "string"
            metricName = "string"
            operator = "string"
            query = "string"
            resourceIdColumn = "string"
            threshold = int
            timeAggregation = "string"
          }
        ]
      }
      description = "string"
      displayName = "string"
      enabled = bool
      evaluationFrequency = "string"
      muteActionsDuration = "string"
      overrideQueryTimeRange = "string"
      ruleResolveConfiguration = {
        autoResolved = bool
        timeToResolve = "string"
      }
      scopes = [
        "string"
      ]
      severity = int
      skipQueryValidation = bool
      targetResourceTypes = [
        "string"
      ]
      windowSize = "string"
    }
    kind = "string"
  })
}

属性值

scheduledQueryRules

名称	说明	Value
type	资源类型	“Microsoft.Insights/scheduledQueryRules@2023-03-15-preview”
name	资源名称	字符串 (必需) 字符限制：1-260 有效字符：不得使用： `*<>%{}&:\\?/#` 或控制字符不得以空格或句点结尾。
location	资源所在的地理位置	字符串 (必需)
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。
kind	指示计划查询规则的类型。默认值为 LogAlert。	“LogAlert” “LogToMetric”
标识	资源的标识。	标识
properties	资源的规则属性。	ScheduledQueryRuleProperties (必需)

标识

名称	说明	Value
type	托管服务标识的类型。	“SystemAssigned” “UserAssigned” (必需)
identity_ids	与资源关联的用户标识列表。用户标识字典密钥引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	用户标识 ID 数组。

ScheduledQueryRuleProperties

名称	说明	值
actions	触发警报时要调用的操作。	操作
autoMitigate	指示是否应自动解决警报的标志。默认值为 true。仅与 LogAlert 类型的规则相关。	bool
checkWorkspaceAlertsStorageConfigured	指示此计划查询规则是否应存储在客户的存储中的标志。默认值为 false。仅与 LogAlert 类型的规则相关。	bool
条件	定义计划查询规则条件的规则条件。	ScheduledQueryRuleCriteria
description	计划查询规则的说明。	字符串
displayName	警报规则的显示名称	字符串
enabled	指示是否启用此计划查询规则的标志。值应为 true 或 false	bool
evaluationFrequency	以 ISO 8601 持续时间格式表示的计划查询规则的计算频率。仅对 LogAlert 类型的规则相关且是必需的。	字符串
muteActionsDuration	触发警报后，) 以 ISO 8601 持续时间格式将所选时间段的操作 (静音。仅与 LogAlert 类型的规则相关。	字符串
overrideQueryTimeRange	如果指定，则替代查询时间范围， (默认值为 WindowSize*NumberOfEvaluationPeriods) 。仅与 LogAlert 类型的规则相关。	字符串
ruleResolveConfiguration	定义用于解决触发的警报的配置。仅与 LogAlert 类型的规则相关。	RuleResolveConfiguration
范围	此计划查询规则的作用域为的资源 ID 列表。	string[]
severity	警报的严重性。应为 [0-4] 之间的整数。值 0 最严重。仅对 LogAlert 类型的规则相关且是必需的。	int
skipQueryValidation	指示是否应验证提供的查询的标志。默认值为 false。仅与 LogAlert 类型的规则相关。	bool
targetResourceTypes	创建/更新警报的目标资源 () 的资源类型列表。例如，如果范围是资源组，而 targetResourceTypes 是 Microsoft.Compute/virtualMachines，则会为资源组中满足警报条件的每个虚拟机触发不同的警报。仅与 LogAlert 类型的规则相关	string[]
windowSize	以 ISO 8601 持续时间格式 () ，警报查询将在此时间段 (箱大小) 执行。仅对 LogAlert 类型的规则相关且是必需的。	字符串

“操作”

名称	说明	值
actionGroups	触发警报时要调用的操作组资源 ID。	string[]
actionProperties	操作属性的属性。	对象 (object)
customProperties	警报有效负载的属性。	对象 (object)

ScheduledQueryRuleCriteria

名称	说明	值
allOf	要根据指定范围进行评估的条件列表	Condition[]

条件

名称	说明	值
dimensions	维度条件列表	Dimension[]
failingPeriods	在所选回溯时间范围内引发警报所需的最小冲突数。仅与 LogAlert 类型的规则相关。	ConditionFailingPeriods
metricMeasureColumn	包含指标度量值编号的列。仅与 LogAlert 类型的规则相关。	字符串
metricName	要发送的指标的名称。仅对类型 LogToMetric 的规则相关且是必需的。	字符串
运算符后的表达式	criteria 运算符。仅对 LogAlert 类型的规则相关且是必需的。	“Equals” “GreaterThan” “GreaterThanOrEqual” “LessThan” “LessThanOrEqual”
query	日志查询警报	字符串
resourceIdColumn	包含资源 ID 的列。列的内容必须是格式为资源 ID 的 URI。仅与 LogAlert 类型的规则相关。	字符串
阈值	激活警报的条件阈值。仅对 LogAlert 类型的规则相关且是必需的。	int
timeAggregation	聚合类型。仅对 LogAlert 类型的规则相关且是必需的。	“Average” “Count” “最大值” “Minimum” “Total”

维度

名称	说明	值
name	维度的名称	字符串 (必需)
运算符后的表达式	维度值的运算符	“排除” “Include” (必需)
值	维度值列表	string[] (必需的)

ConditionFailingPeriods

名称	说明	值
minFailingPeriodsToAlert	触发警报的冲突数。应小于或等于 numberOfEvaluationPeriods。默认值为 1	int
numberOfEvaluationPeriods	聚合的回溯点数。回溯时间窗口是根据聚合粒度 (windowSize) 和所选聚合点数计算的。默认值为 1	int

RuleResolveConfiguration

名称	说明	值
autoResolved	指示是否自动解决触发的警报的标志。	bool
timeToResolve	在自动解决触发的警报之前，规则必须评估为正常状态的持续时间，以 ISO 8601 持续时间格式表示。	字符串

通过

Microsoft.Insights scheduledQueryRules

Bicep 资源定义

注解

资源格式

属性值

scheduledQueryRules

标识

ScheduledQueryRuleProperties

“操作”

ScheduledQueryRuleCriteria

条件

维度

ConditionFailingPeriods

RuleResolveConfiguration

ARM 模板资源定义

注解

资源格式

属性值

scheduledQueryRules

标识

ScheduledQueryRuleProperties

“操作”

ScheduledQueryRuleCriteria

条件

维度

ConditionFailingPeriods

RuleResolveConfiguration

Terraform (AzAPI 提供程序) 资源定义

资源格式

属性值

scheduledQueryRules

标识

ScheduledQueryRuleProperties

“操作”

ScheduledQueryRuleCriteria

条件

维度

ConditionFailingPeriods

RuleResolveConfiguration

反馈

反馈

其他资源