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

Microsoft.Insights scheduledQueryRules 2018-04-16

项目
08/15/2024

Bicep 资源定义

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

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

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

言论

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

资源格式

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

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2018-04-16' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  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: 'ResultCount'
    }
  }
}

操作对象

设置 odata.type 属性以指定对象的类型。

对于 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction，请使用：

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

对于 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction，请使用：

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

属性值

scheduledQueryRules

名字	描述	价值
名字	资源名称	string （必需）字符限制：1-260 有效字符：无法使用： `*<>%{}&:\\?/#\|` 或控制字符不能以空格或句点结尾。
位置	资源位置	string （必需）
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
性能	资源的规则属性。	LogSearchRule （必需）

LogSearchRule

名字	描述	价值
行动	需要对规则执行执行操作。	操作（必需）
autoMitigate	指示是否应自动解决警报的标志。默认值为 false。	bool
描述	日志搜索规则的说明。	字符串
displayName	警报规则的显示名称	字符串
启用	指示是否启用日志搜索规则的标志。值应为 true 或 false	“false” “true”
附表	规则的计划（频率、时间窗口）。操作类型必需 - AlertingAction	计划
源	数据源将针对哪个规则查询数据	源（必需）

行动

名字	描述	价值
odata.type	设置对象类型	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（必需）

AlertingAction

名字	描述	价值
odata.type	指定操作。支持的值 - AlertingAction、LogToMetricAction	“Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction”（必需）
aznsAction	Azure 操作组参考。	AzNsActionGroup
严厉	警报的严重性	'0' '1' '2' '3' “4”（必需）
throttlingInMin	应限制或禁止警报的时间（以分钟为单位）。	int
触发	导致警报规则的触发器条件。	TriggerCondition （必需）

AzNsActionGroup

名字	描述	价值
actionGroup	Azure 操作组参考。	string[]
customWebhookPayload	要为 Azure 操作组中的所有 Webhook URI 发送的自定义有效负载	字符串
emailSubject	Azure 操作组中所有电子邮件 ID 的自定义主题替代	字符串

TriggerCondition

名字	描述	价值
metricTrigger	指标查询规则的触发器条件	LogMetricTrigger
门槛	基于应触发规则的结果或计数阈值。	int （必需）
thresholdOperator	规则的评估操作 - “GreaterThan”或“LessThan”。	“Equal” “GreaterThan” “GreaterThanOrEqual” “LessThan” “LessThanOrEqual”（必需）

LogMetricTrigger

名字	描述	价值
metricColumn	评估特定列的指标	字符串
metricTriggerType	指标触发器类型 - “连续” 或 “Total”	“连续” “Total”
门槛	指标触发器的阈值。	int
thresholdOperator	指标的评估操作 -“GreaterThan”或“LessThan”或“Equal”。	“Equal” “GreaterThan” “GreaterThanOrEqual” “LessThan” “LessThanOrEqual”

LogToMetricAction

名字	描述	价值
odata.type	指定操作。支持的值 - AlertingAction、LogToMetricAction	“Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction”（必需）
标准	指标条件	条件[] （必需）

标准

名字	描述	价值
尺寸	用于创建指标的维度列表	维度[]
metricName	指标的名称	string （必需）

尺寸

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

附表

名字	描述	价值
frequencyInMinutes	应评估规则条件的频率（以分钟为单位）。	int （必需）
timeWindowInMinutes	需要为查询提取数据的时间范围（应大于或等于 frequencyInMinutes）。	int （必需）

源

名字	描述	价值
authorizedResources	查询中引用的资源列表	string[]
dataSourceId	要对其运行日志搜索查询的资源 URI。	string （必需）
查询	日志搜索查询。操作类型必需 - AlertingAction	字符串
queryType	将值设置为“ResultCount”。	“ResultCount”

快速入门模板

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

模板	描述
为 azure 业务连续性项创建警报规则	此模板创建警报规则和用户分配的 MSI。它还向订阅分配 MSI 读取器访问权限，以便警报规则有权查询所需的受保护项和最新的恢复点详细信息。

ARM 模板资源定义

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

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

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

言论

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

资源格式

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

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2018-04-16",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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": "ResultCount"
    }
  }
}

操作对象

设置 odata.type 属性以指定对象的类型。

对于 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction，请使用：

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

对于 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction，请使用：

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

属性值

scheduledQueryRules

名字	描述	价值
类型	资源类型	“Microsoft.Insights/scheduledQueryRules”
apiVersion	资源 API 版本	'2018-04-16'
名字	资源名称	string （必需）字符限制：1-260 有效字符：无法使用： `*<>%{}&:\\?/#\|` 或控制字符不能以空格或句点结尾。
位置	资源位置	string （必需）
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
性能	资源的规则属性。	LogSearchRule （必需）

LogSearchRule

名字	描述	价值
行动	需要对规则执行执行操作。	操作（必需）
autoMitigate	指示是否应自动解决警报的标志。默认值为 false。	bool
描述	日志搜索规则的说明。	字符串
displayName	警报规则的显示名称	字符串
启用	指示是否启用日志搜索规则的标志。值应为 true 或 false	“false” “true”
附表	规则的计划（频率、时间窗口）。操作类型必需 - AlertingAction	计划
源	数据源将针对哪个规则查询数据	源（必需）

行动

名字	描述	价值
odata.type	设置对象类型	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（必需）

AlertingAction

名字	描述	价值
odata.type	指定操作。支持的值 - AlertingAction、LogToMetricAction	“Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction”（必需）
aznsAction	Azure 操作组参考。	AzNsActionGroup
严厉	警报的严重性	'0' '1' '2' '3' “4”（必需）
throttlingInMin	应限制或禁止警报的时间（以分钟为单位）。	int
触发	导致警报规则的触发器条件。	TriggerCondition （必需）

AzNsActionGroup

名字	描述	价值
actionGroup	Azure 操作组参考。	string[]
customWebhookPayload	要为 Azure 操作组中的所有 Webhook URI 发送的自定义有效负载	字符串
emailSubject	Azure 操作组中所有电子邮件 ID 的自定义主题替代	字符串

TriggerCondition

名字	描述	价值
metricTrigger	指标查询规则的触发器条件	LogMetricTrigger
门槛	基于应触发规则的结果或计数阈值。	int （必需）
thresholdOperator	规则的评估操作 - “GreaterThan”或“LessThan”。	“Equal” “GreaterThan” “GreaterThanOrEqual” “LessThan” “LessThanOrEqual”（必需）

LogMetricTrigger

名字	描述	价值
metricColumn	评估特定列的指标	字符串
metricTriggerType	指标触发器类型 - “连续” 或 “Total”	“连续” “Total”
门槛	指标触发器的阈值。	int
thresholdOperator	指标的评估操作 -“GreaterThan”或“LessThan”或“Equal”。	“Equal” “GreaterThan” “GreaterThanOrEqual” “LessThan” “LessThanOrEqual”

LogToMetricAction

名字	描述	价值
odata.type	指定操作。支持的值 - AlertingAction、LogToMetricAction	“Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction”（必需）
标准	指标条件	条件[] （必需）

标准

名字	描述	价值
尺寸	用于创建指标的维度列表	维度[]
metricName	指标的名称	string （必需）

尺寸

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

附表

名字	描述	价值
frequencyInMinutes	应评估规则条件的频率（以分钟为单位）。	int （必需）
timeWindowInMinutes	需要为查询提取数据的时间范围（应大于或等于 frequencyInMinutes）。	int （必需）

源

名字	描述	价值
authorizedResources	查询中引用的资源列表	string[]
dataSourceId	要对其运行日志搜索查询的资源 URI。	string （必需）
查询	日志搜索查询。操作类型必需 - AlertingAction	字符串
queryType	将值设置为“ResultCount”。	“ResultCount”

快速入门模板

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

模板	描述
为 azure 业务连续性项创建警报规则	此模板创建警报规则和用户分配的 MSI。它还向订阅分配 MSI 读取器访问权限，以便警报规则有权查询所需的受保护项和最新的恢复点详细信息。

Terraform （AzAPI 提供程序）资源定义

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

资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2018-04-16"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    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 = "ResultCount"
      }
    }
  })
}

操作对象

设置 odata.type 属性以指定对象的类型。

对于 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction，请使用：

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

对于 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction，请使用：

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

属性值

scheduledQueryRules

名字	描述	价值
类型	资源类型	“Microsoft.Insights/scheduledQueryRules@2018-04-16”
名字	资源名称	string （必需）字符限制：1-260 有效字符：无法使用： `*<>%{}&:\\?/#\|` 或控制字符不能以空格或句点结尾。
位置	资源位置	string （必需）
parent_id	若要部署到资源组，请使用该资源组的 ID。	string （必需）
标签	资源标记	标记名称和值的字典。
性能	资源的规则属性。	LogSearchRule （必需）

LogSearchRule

名字	描述	价值
行动	需要对规则执行执行操作。	操作（必需）
autoMitigate	指示是否应自动解决警报的标志。默认值为 false。	bool
描述	日志搜索规则的说明。	字符串
displayName	警报规则的显示名称	字符串
启用	指示是否启用日志搜索规则的标志。值应为 true 或 false	“false” “true”
附表	规则的计划（频率、时间窗口）。操作类型必需 - AlertingAction	计划
源	数据源将针对哪个规则查询数据	源（必需）

行动

名字	描述	价值
odata.type	设置对象类型	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（必需）

AlertingAction

名字	描述	价值
odata.type	指定操作。支持的值 - AlertingAction、LogToMetricAction	“Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction”（必需）
aznsAction	Azure 操作组参考。	AzNsActionGroup
严厉	警报的严重性	"0" "1" "2" "3" “4”（必需）
throttlingInMin	应限制或禁止警报的时间（以分钟为单位）。	int
触发	导致警报规则的触发器条件。	TriggerCondition （必需）

AzNsActionGroup

名字	描述	价值
actionGroup	Azure 操作组参考。	string[]
customWebhookPayload	要为 Azure 操作组中的所有 Webhook URI 发送的自定义有效负载	字符串
emailSubject	Azure 操作组中所有电子邮件 ID 的自定义主题替代	字符串

TriggerCondition

名字	描述	价值
metricTrigger	指标查询规则的触发器条件	LogMetricTrigger
门槛	基于应触发规则的结果或计数阈值。	int （必需）
thresholdOperator	规则的评估操作 - “GreaterThan”或“LessThan”。	“Equal” “GreaterThan” “GreaterThanOrEqual” “LessThan” “LessThanOrEqual” （必需）

LogMetricTrigger

名字	描述	价值
metricColumn	评估特定列的指标	字符串
metricTriggerType	指标触发器类型 - “连续” 或 “Total”	“连续” “Total”
门槛	指标触发器的阈值。	int
thresholdOperator	指标的评估操作 -“GreaterThan”或“LessThan”或“Equal”。	“Equal” “GreaterThan” “GreaterThanOrEqual” “LessThan” “LessThanOrEqual”

LogToMetricAction

名字	描述	价值
odata.type	指定操作。支持的值 - AlertingAction、LogToMetricAction	“Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction”（必需）
标准	指标条件	条件[] （必需）

标准

名字	描述	价值
尺寸	用于创建指标的维度列表	维度[]
metricName	指标的名称	string （必需）

尺寸

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

附表

名字	描述	价值
frequencyInMinutes	应评估规则条件的频率（以分钟为单位）。	int （必需）
timeWindowInMinutes	需要为查询提取数据的时间范围（应大于或等于 frequencyInMinutes）。	int （必需）

源

名字	描述	价值
authorizedResources	查询中引用的资源列表	string[]
dataSourceId	要对其运行日志搜索查询的资源 URI。	string （必需）
查询	日志搜索查询。操作类型必需 - AlertingAction	字符串
queryType	将值设置为“ResultCount”。	“ResultCount”

通过

Microsoft.Insights scheduledQueryRules 2018-04-16

Bicep 资源定义

言论

资源格式

操作对象

属性值

scheduledQueryRules

LogSearchRule

行动

AlertingAction

AzNsActionGroup

TriggerCondition

LogMetricTrigger

LogToMetricAction

标准

尺寸

附表

源

快速入门模板

ARM 模板资源定义

言论

资源格式

操作对象

属性值

scheduledQueryRules

LogSearchRule

行动

AlertingAction

AzNsActionGroup

TriggerCondition

LogMetricTrigger

LogToMetricAction

标准

尺寸

附表

源

快速入门模板

Terraform （AzAPI 提供程序）资源定义

资源格式

操作对象

属性值

scheduledQueryRules

LogSearchRule

行动

AlertingAction

AzNsActionGroup

TriggerCondition

LogMetricTrigger

LogToMetricAction

标准

尺寸

附表

源

反馈

其他资源