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

Scheduled Query Rules - Update

更新日志搜索规则。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}?api-version=2018-04-16

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

ruleName
path True
  • string

规则的名称。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

请求正文

Name Type Description
properties.enabled

指示是否启用日志搜索规则的标志。 值应为 true 或 false

tags
  • object

资源标记

响应

Name Type Description
200 OK

成功请求更新日志搜索规则

Other Status Codes

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Patch Log Search Rule

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourcegroups/my-resource-group/providers/Microsoft.Insights/scheduledQueryRules/logalertfoo?api-version=2018-04-16

{
  "properties": {
    "enabled": "true"
  }
}

Sample Response

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo",
  "name": "logalertfoo",
  "type": "Microsoft.Insights/scheduledQueryRules",
  "location": "West US",
  "tags": {},
  "properties": {
    "description": "log alert description",
    "enabled": "true",
    "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z",
    "provisioningState": "Succeeded",
    "source": {
      "query": "requests",
      "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI",
      "queryType": "ResultCount"
    },
    "schedule": {
      "frequencyInMinutes": 15,
      "timeWindowInMinutes": 15
    },
    "action": {
      "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
      "severity": "1",
      "aznsAction": {
        "actionGroup": [],
        "emailSubject": "Email Header",
        "customWebhookPayload": "{}"
      },
      "trigger": {
        "thresholdOperator": "GreaterThan",
        "threshold": 3,
        "metricTrigger": {
          "thresholdOperator": "GreaterThan",
          "threshold": 5,
          "metricTriggerType": "Consecutive",
          "metricColumn": "ColumnName"
        }
      }
    }
  }
}

定义

AlertingAction

指定规则类型为“警报”时需要执行的操作

AlertSeverity

警报的严重性级别

AzNsActionGroup

Azure 操作组

ConditionalOperator

结果条件评估条件。

Criteria

指定将日志转换为指标的条件。

Dimension

指定将日志转换为指标的条件。

enabled

指示是否启用日志搜索规则的标志。 值应为 true 或 false

ErrorContract

描述错误响应的格式。

ErrorResponse

描述错误响应的格式。

LogMetricTrigger

日志指标触发器描述符。

LogSearchRuleResource

日志搜索规则资源。

LogSearchRuleResourcePatch

用于修补操作的日志搜索规则资源。

LogToMetricAction

当规则类型将日志转换为指标时,需要执行指定操作

metricTriggerType

指标触发器类型 - “连续” 或 “Total”

operator

维度值的运算符

provisioningState

计划查询规则的预配状态

QueryType

将值设置为“ResultAccount”

Schedule

定义运行搜索的频率和时间间隔。

Source

指定日志搜索查询。

TriggerCondition

导致日志搜索规则的条件。

AlertingAction

指定规则类型为“警报”时需要执行的操作

Name Type Description
aznsAction

Azure 操作组参考。

odata.type string:
  • Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction

指定操作。 支持的值 - AlertingAction、LogToMetricAction

severity

警报的严重性

throttlingInMin
  • integer

时间 (分钟) ,应对其限制或禁止警报。

trigger

导致警报规则的触发器条件。

AlertSeverity

警报的严重性级别

Name Type Description
0
  • string
1
  • string
2
  • string
3
  • string
4
  • string

AzNsActionGroup

Azure 操作组

Name Type Description
actionGroup
  • string[]

Azure 操作组参考。

customWebhookPayload
  • string

要针对 Azure 操作组中所有 Webhook URI 发送的自定义有效负载

emailSubject
  • string

Azure 操作组中所有电子邮件 ID 的自定义主题替代

ConditionalOperator

结果条件评估条件。

Name Type Description
Equal
  • string
GreaterThan
  • string
GreaterThanOrEqual
  • string
LessThan
  • string
LessThanOrEqual
  • string

Criteria

指定将日志转换为指标的条件。

Name Type Description
dimensions

用于创建指标的维度列表

metricName
  • string

指标的名称

Dimension

指定将日志转换为指标的条件。

Name Type Description
name
  • string

维度的名称

operator

维度值的运算符

values
  • string[]

维度值列表

enabled

指示是否启用日志搜索规则的标志。 值应为 true 或 false

Name Type Description
false
  • string
true
  • string

ErrorContract

描述错误响应的格式。

Name Type Description
error

错误详细信息。

ErrorResponse

描述错误响应的格式。

Name Type Description
code
  • string

错误代码

message
  • string

指示操作失败的原因的错误消息。

LogMetricTrigger

日志指标触发器描述符。

Name Type Default Value Description
metricColumn
  • string

对特定列的指标进行评估

metricTriggerType Consecutive

指标触发器类型 - “连续” 或 “Total”

threshold
  • number

指标触发器的阈值。

thresholdOperator GreaterThanOrEqual

指标 -“GreaterThan”或“LessThan”或“Equal”的评估操作。

LogSearchRuleResource

日志搜索规则资源。

Name Type Default Value Description
etag
  • string

不需要 etag 字段。 如果在响应正文中提供,则还必须根据正常的 etag 约定将其作为标头提供。 实体标记用于比较同一请求资源的两个或多个实体。 HTTP/1.1 在 etag (第 14.19 节) 中使用实体标记,If-Match (第 14.24 节) 、If-None-Match (第 14.26 节) ,If-Range (第 14.27 节) 标头字段。

id
  • string

Azure 资源 ID

kind
  • string

门户/工具/等用于为相同类型的资源呈现不同的 UX 体验的元数据;例如,ApiApps 是一种 Microsoft.Web/sites 类型。 如果受支持,资源提供程序必须验证并保留此值。

location
  • string

资源位置

name
  • string

Azure 资源名称

properties.action Action:

需要对规则执行执行操作。

properties.autoMitigate
  • boolean
False

指示是否应自动解决警报的标志。 默认值为 false。

properties.createdWithApiVersion
  • string

创建此警报规则时使用的 API 版本

properties.description
  • string

日志搜索规则的说明。

properties.displayName
  • string

警报规则的显示名称

properties.enabled

指示是否启用日志搜索规则的标志。 值应为 true 或 false

properties.isLegacyLogAnalyticsRule
  • boolean

如此 如果警报规则是旧式 Log Analytic 规则

properties.lastUpdatedTime
  • string

上次以 IS08601 格式更新规则的时间。

properties.provisioningState

计划查询规则的预配状态

properties.schedule

计划规则的频率、时间窗口) (。 操作类型必需 - AlertingAction

properties.source

数据源将针对哪个规则查询数据

tags
  • object

资源标记

type
  • string

Azure 资源类型

LogSearchRuleResourcePatch

用于修补操作的日志搜索规则资源。

Name Type Description
properties.enabled

指示是否启用日志搜索规则的标志。 值应为 true 或 false

tags
  • object

资源标记

LogToMetricAction

当规则类型将日志转换为指标时,需要执行指定操作

Name Type Description
criteria

指标条件

odata.type string:
  • Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction

指定操作。 支持的值 - AlertingAction、LogToMetricAction

metricTriggerType

指标触发器类型 - “连续” 或 “Total”

Name Type Description
Consecutive
  • string
Total
  • string

operator

维度值的运算符

Name Type Description
Include
  • string

provisioningState

计划查询规则的预配状态

Name Type Description
Canceled
  • string
Deploying
  • string
Failed
  • string
Succeeded
  • string

QueryType

将值设置为“ResultAccount”

Name Type Description
ResultCount
  • string

Schedule

定义运行搜索的频率和时间间隔。

Name Type Description
frequencyInMinutes
  • integer

频率 (分钟) 应评估规则条件。

timeWindowInMinutes
  • integer

需要为查询 (提取数据的时间范围应大于或等于 frequencyInMinutes) 。

Source

指定日志搜索查询。

Name Type Description
authorizedResources
  • string[]

查询中引用的资源列表

dataSourceId
  • string

要运行日志搜索查询的资源 URI。

query
  • string

日志搜索查询。 操作类型必需 - AlertingAction

queryType

将值设置为“ResultCount”。

TriggerCondition

导致日志搜索规则的条件。

Name Type Default Value Description
metricTrigger

指标查询规则的触发器条件

threshold
  • number

基于应触发规则的结果或计数阈值。

thresholdOperator GreaterThanOrEqual

规则的评估操作 - “GreaterThan”或“LessThan”。