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

Microsoft.Insights scheduledQueryRules

Bicep 资源定义

可以使用目标操作部署 scheduledQueryRules 资源类型:

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

言论

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

资源格式

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

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2023-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    actions: {
      actionGroups: [
        'string'
      ]
      actionProperties: {
        {customized property}: 'string'
      }
      customProperties: {
        {customized property}: 'string'
      }
    }
    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

名字 描述 价值
名字 资源名称 string (必需)

字符限制:1-260

有效字符:
无法使用:
*<>%{}&:\\?/#| 或控制字符

不能以空格或句点结尾。
位置 资源所在的地理位置 string (必需)
标签 资源标记。 标记名称和值的字典。 请参阅模板 中的 标记
指示计划查询规则的类型。 默认值为 LogAlert。 “LogAlert”
“LogToMetric”
身份 资源的标识。 标识
性能 资源的规则属性。 ScheduledQueryRuleProperties (必需)

身份

名字 描述 价值
类型 托管服务标识的类型。 “None”
“SystemAssigned”
“UserAssigned”(必需)
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

名字 描述 价值
{自定义属性} UserIdentityProperties

UserIdentityProperties

此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。

ScheduledQueryRuleProperties

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

行动

名字 描述 价值
actionGroups 触发警报时要调用的操作组资源 ID。 string[]
actionProperties 操作属性的属性。 ActionsActionProperties
customProperties 警报有效负载的属性。 ActionsCustomProperties

ActionsActionProperties

名字 描述 价值
{自定义属性} 字符串

ActionsCustomProperties

名字 描述 价值
{自定义属性} 字符串

ScheduledQueryRuleCriteria

名字 描述 价值
allOf 要针对指定范围评估的条件列表 条件[]

条件

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

尺寸

名字 描述 价值
名字 维度的名称 string (必需)
算子 维度值的运算符 “Exclude”
“Include”(必需)
维度值列表 string[] (必需)

ConditionFailingPeriods

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

RuleResolveConfiguration

名字 描述 价值
autoResolved 指示是否自动解决触发的警报的标志。 bool
timeToResolve 规则必须在触发的警报自动解析为 ISO 8601 持续时间格式之前评估为正常持续时间。 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
为 azure 业务连续性项创建警报规则

部署到 Azure
此模板创建警报规则和用户分配的 MSI。 它还向订阅分配 MSI 读取器访问权限,以便警报规则有权查询所需的受保护项和最新的恢复点详细信息。

ARM 模板资源定义

可以使用目标操作部署 scheduledQueryRules 资源类型:

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

言论

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

资源格式

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

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2023-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "actions": {
      "actionGroups": [ "string" ],
      "actionProperties": {
        "{customized property}": "string"
      },
      "customProperties": {
        "{customized property}": "string"
      }
    },
    "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

名字 描述 价值
类型 资源类型 “Microsoft.Insights/scheduledQueryRules”
apiVersion 资源 API 版本 '2023-12-01'
名字 资源名称 string (必需)

字符限制:1-260

有效字符:
无法使用:
*<>%{}&:\\?/#| 或控制字符

不能以空格或句点结尾。
位置 资源所在的地理位置 string (必需)
标签 资源标记。 标记名称和值的字典。 请参阅模板 中的 标记
指示计划查询规则的类型。 默认值为 LogAlert。 “LogAlert”
“LogToMetric”
身份 资源的标识。 标识
性能 资源的规则属性。 ScheduledQueryRuleProperties (必需)

身份

名字 描述 价值
类型 托管服务标识的类型。 “None”
“SystemAssigned”
“UserAssigned”(必需)
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

名字 描述 价值
{自定义属性} UserIdentityProperties

UserIdentityProperties

此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。

ScheduledQueryRuleProperties

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

行动

名字 描述 价值
actionGroups 触发警报时要调用的操作组资源 ID。 string[]
actionProperties 操作属性的属性。 ActionsActionProperties
customProperties 警报有效负载的属性。 ActionsCustomProperties

ActionsActionProperties

名字 描述 价值
{自定义属性} 字符串

ActionsCustomProperties

名字 描述 价值
{自定义属性} 字符串

ScheduledQueryRuleCriteria

名字 描述 价值
allOf 要针对指定范围评估的条件列表 条件[]

条件

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

尺寸

名字 描述 价值
名字 维度的名称 string (必需)
算子 维度值的运算符 “Exclude”
“Include”(必需)
维度值列表 string[] (必需)

ConditionFailingPeriods

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

RuleResolveConfiguration

名字 描述 价值
autoResolved 指示是否自动解决触发的警报的标志。 bool
timeToResolve 规则必须在触发的警报自动解析为 ISO 8601 持续时间格式之前评估为正常持续时间。 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
为 azure 业务连续性项创建警报规则

部署到 Azure
此模板创建警报规则和用户分配的 MSI。 它还向订阅分配 MSI 读取器访问权限,以便警报规则有权查询所需的受保护项和最新的恢复点详细信息。

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

可以使用目标操作部署 scheduledQueryRules 资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2023-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      actions = {
        actionGroups = [
          "string"
        ]
        actionProperties = {
          {customized property} = "string"
        }
        customProperties = {
          {customized property} = "string"
        }
      }
      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

名字 描述 价值
类型 资源类型 “Microsoft.Insights/scheduledQueryRules@2023-12-01”
名字 资源名称 string (必需)

字符限制:1-260

有效字符:
无法使用:
*<>%{}&:\\?/#| 或控制字符

不能以空格或句点结尾。
位置 资源所在的地理位置 string (必需)
parent_id 若要部署到资源组,请使用该资源组的 ID。 string (必需)
标签 资源标记。 标记名称和值的字典。
指示计划查询规则的类型。 默认值为 LogAlert。 “LogAlert”
“LogToMetric”
身份 资源的标识。 标识
性能 资源的规则属性。 ScheduledQueryRuleProperties (必需)

身份

名字 描述 价值
类型 托管服务标识的类型。 “SystemAssigned”
“UserAssigned”(必需)
identity_ids 与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 用户标识 ID 的数组。

IdentityUserAssignedIdentities

名字 描述 价值
{自定义属性} UserIdentityProperties

UserIdentityProperties

此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。

ScheduledQueryRuleProperties

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

行动

名字 描述 价值
actionGroups 触发警报时要调用的操作组资源 ID。 string[]
actionProperties 操作属性的属性。 ActionsActionProperties
customProperties 警报有效负载的属性。 ActionsCustomProperties

ActionsActionProperties

名字 描述 价值
{自定义属性} 字符串

ActionsCustomProperties

名字 描述 价值
{自定义属性} 字符串

ScheduledQueryRuleCriteria

名字 描述 价值
allOf 要针对指定范围评估的条件列表 条件[]

条件

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

尺寸

名字 描述 价值
名字 维度的名称 string (必需)
算子 维度值的运算符 “排除”
“Include”(必需)
维度值列表 string[] (必需)

ConditionFailingPeriods

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

RuleResolveConfiguration

名字 描述 价值
autoResolved 指示是否自动解决触发的警报的标志。 bool
timeToResolve 规则必须在触发的警报自动解析为 ISO 8601 持续时间格式之前评估为正常持续时间。 字符串