通过

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

Activity Log Alerts - Update

  • 参考
Service:
Monitor
API Version:
2020-10-01

汇报现有警报规则中的“tags”和“enabled”字段。 此方法用于更新警报规则标记，以及启用或禁用警报规则。 若要更新其他字段，请使用 CreateOrUpdate 操作。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}?api-version=2020-10-01

URI 参数

名称 在 必需 类型 说明
activityLogAlertName
 path True

string

活动日志警报规则的名称。
resourceGroupName
 path True

string

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

string

目标订阅的 ID。
api-version
 query True

string

要用于此操作的 API 版本。

请求正文

名称 类型 说明
properties.enabled

boolean

指示是否启用此活动日志警报规则。 如果未启用活动日志警报规则，则不会激活其任何操作。
tags

object

资源标记

响应

名称 类型 说明
200 OK

ActivityLogAlertResource

已成功更新现有活动日志警报规则。
Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

Patch an Activity Log Alert rule

Sample Request

PATCH https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRule?api-version=2020-10-01

{
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "enabled": false
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "location": "Global",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "scopes": [
      "/subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "Administrative"
        },
        {
          "field": "level",
          "equals": "Error"
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": false,
    "description": "Description of sample Activity Log Alert rule."
  }
}

定义

名称 说明
ActionGroup

指向 Azure 操作组的指针。
ActionList

活动日志警报规则操作的列表。
ActivityLogAlertResource

活动日志警报规则资源。
AlertRuleAllOfCondition

满足其所有成员条件时满足的活动日志警报规则条件。
AlertRuleAnyOfOrLeafCondition

满足其所有成员条件时满足的活动日志警报规则条件。 每个条件可以是以下类型之一： 重要提示：每种类型都有其唯一的属性子集。 不同类型的属性不能存在于一个条件中。

  • 叶条件 - 必须包含“field”和“equals”或“containsAny”。 请注意，“anyOf” 不应 在叶条件中设置。
  • AnyOf 条件 -必须仅 包含“anyOf” (这是叶条件) 数组。 请注意，“field”、“equals”和“containsAny” 不应 在 AnyOf 条件中设置。
AlertRuleLeafCondition

通过比较活动日志事件的字段和值来满足的活动日志警报规则条件。 此条件必须包含“field”和“equals”或“containsAny”。
AlertRulePatchObject

修补操作正文的活动日志警报规则对象。
ErrorResponse

错误响应。

ActionGroup

指向 Azure 操作组的指针。

名称 类型 说明
actionGroupId

string

操作组的资源 ID。 这不能为 null 或空。
webhookProperties

object

要包含在发布操作中的自定义属性的字典。 这些数据追加到 Webhook 有效负载。

ActionList

活动日志警报规则操作的列表。

名称 类型 说明
actionGroups

ActionGroup[]

操作组的列表。

ActivityLogAlertResource

活动日志警报规则资源。

名称 类型 默认值 说明
id

string

资源 ID。
location

string

global

资源的位置。 全球、西欧和北欧区域支持 Azure 活动日志警报规则。
name

string

资源的名称。
properties.actions

ActionList

满足条件时将激活的操作。
properties.condition

AlertRuleAllOfCondition

将导致此警报激活的条件。
properties.description

string

此活动日志警报规则的说明。
properties.enabled

boolean

True

指示是否启用此活动日志警报规则。 如果未启用活动日志警报规则，则不会激活其任何操作。
properties.scopes

string[]

将用作前缀的资源 ID 列表。 该警报仅适用于资源 ID 属于其中一个前缀的活动日志事件。 此列表必须至少包含一项。
tags

object

资源的标记。
type

string

资源类型。

AlertRuleAllOfCondition

满足其所有成员条件时满足的活动日志警报规则条件。

名称 类型 说明
allOf

AlertRuleAnyOfOrLeafCondition[]

活动日志警报规则条件的列表。

AlertRuleAnyOfOrLeafCondition

满足其所有成员条件时满足的活动日志警报规则条件。 每个条件可以是以下类型之一： 重要提示：每种类型都有其唯一的属性子集。 不同类型的属性不能存在于一个条件中。

  • 叶条件 - 必须包含“field”和“equals”或“containsAny”。 请注意，“anyOf” 不应 在叶条件中设置。
  • AnyOf 条件 -必须仅 包含“anyOf” (这是叶条件) 数组。 请注意，“field”、“equals”和“containsAny” 不应 在 AnyOf 条件中设置。
名称 类型 说明
anyOf

AlertRuleLeafCondition[]

活动日志警报规则“anyOf”条件。
至少满足其一个成员叶条件时满足的活动日志警报规则条件。
containsAny

string[]

事件字段的值将与此数组中的值进行比较， (不区分大小写) 确定是否满足条件。
equals

string

事件字段的值将与此值进行比较， (不区分大小写) ，以确定是否满足条件。
field

string

此条件将检查的活动日志事件的字段的名称。 此字段的可能值 (不区分大小写) ：“resourceId”、“category”、“caller”、“level”、“operationName”、“resourceGroup”、“resourceProvider”、“status”、“subStatus”、“resourceType”或以“properties”开头的任何内容。

AlertRuleLeafCondition

通过比较活动日志事件的字段和值来满足的活动日志警报规则条件。 此条件必须包含“field”和“equals”或“containsAny”。

名称 类型 说明
containsAny

string[]

事件字段的值将与此数组中的值进行比较， (不区分大小写) 确定是否满足条件。
equals

string

事件字段的值将与此值进行比较， (不区分大小写) ，以确定是否满足条件。
field

string

此条件将检查的活动日志事件的字段的名称。 此字段的可能值 (不区分大小写) ：“resourceId”、“category”、“caller”、“level”、“operationName”、“resourceGroup”、“resourceProvider”、“status”、“subStatus”、“resourceType”或以“properties”开头的任何内容。

AlertRulePatchObject

修补操作正文的活动日志警报规则对象。

名称 类型 默认值 说明
properties.enabled

boolean

True

指示是否启用此活动日志警报规则。 如果未启用活动日志警报规则，则不会激活其任何操作。
tags

object

资源标记

ErrorResponse

错误响应。

名称 类型 说明
code

string

错误代码。
message

string

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