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

Activity Log Alerts - Update

参考

服务:: Monitor

API 版本:: 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 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Patch an Activity Log Alert rule

示例请求

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
  }
}


import com.azure.resourcemanager.monitor.models.AlertRulePatchObject;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for ActivityLogAlerts Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_Update.
     * json
     */
    /**
     * Sample code: Patch an Activity Log Alert rule.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void patchAnActivityLogAlertRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getActivityLogAlerts().updateWithResponse(
            "MyResourceGroup", "SampleActivityLogAlertRule", new AlertRulePatchObject()
                .withTags(mapOf("key1", "fakeTokenPlaceholder", "key2", "fakeTokenPlaceholder")).withEnabled(false),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_Update.json
func ExampleActivityLogAlertsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewActivityLogAlertsClient().Update(ctx, "MyResourceGroup", "SampleActivityLogAlertRule", armmonitor.AlertRulePatchObject{
		Properties: &armmonitor.AlertRulePatchProperties{
			Enabled: to.Ptr(false),
		},
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
			"key2": to.Ptr("value2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ActivityLogAlertResource = armmonitor.ActivityLogAlertResource{
	// 	Name: to.Ptr("SampleActivityLogAlertRule"),
	// 	Type: to.Ptr("Microsoft.Insights/ActivityLogAlerts"),
	// 	ID: to.Ptr("/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule"),
	// 	Location: to.Ptr("Global"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armmonitor.AlertRuleProperties{
	// 		Description: to.Ptr("Description of sample Activity Log Alert rule."),
	// 		Actions: &armmonitor.ActionList{
	// 			ActionGroups: []*armmonitor.ActionGroupAutoGenerated{
	// 				{
	// 					ActionGroupID: to.Ptr("/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup"),
	// 					WebhookProperties: map[string]*string{
	// 						"sampleWebhookProperty": to.Ptr("SamplePropertyValue"),
	// 					},
	// 			}},
	// 		},
	// 		Condition: &armmonitor.AlertRuleAllOfCondition{
	// 			AllOf: []*armmonitor.AlertRuleAnyOfOrLeafCondition{
	// 				{
	// 					Equals: to.Ptr("Administrative"),
	// 					Field: to.Ptr("category"),
	// 				},
	// 				{
	// 					Equals: to.Ptr("Error"),
	// 					Field: to.Ptr("level"),
	// 			}},
	// 		},
	// 		Enabled: to.Ptr(false),
	// 		Scopes: []*string{
	// 			to.Ptr("/subscriptions/187f412d-1758-44d9-b052-169e2564721d")},
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates 'tags' and 'enabled' fields in an existing Alert rule. This method is used to update the Alert rule tags, and to enable or disable the Alert rule. To update other fields use CreateOrUpdate operation.
 *
 * @summary Updates 'tags' and 'enabled' fields in an existing Alert rule. This method is used to update the Alert rule tags, and to enable or disable the Alert rule. To update other fields use CreateOrUpdate operation.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_Update.json
 */
async function patchAnActivityLogAlertRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "187f412d-1758-44d9-b052-169e2564721d";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "MyResourceGroup";
  const activityLogAlertName = "SampleActivityLogAlertRule";
  const activityLogAlertRulePatch = {
    enabled: false,
    tags: { key1: "value1", key2: "value2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.activityLogAlerts.update(
    resourceGroupName,
    activityLogAlertName,
    activityLogAlertRulePatch,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Monitor;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_Update.json
// this example is just showing the usage of "ActivityLogAlerts_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ActivityLogAlertResource created on azure
// for more information of creating ActivityLogAlertResource, please refer to the document of ActivityLogAlertResource
string subscriptionId = "187f412d-1758-44d9-b052-169e2564721d";
string resourceGroupName = "MyResourceGroup";
string activityLogAlertName = "SampleActivityLogAlertRule";
ResourceIdentifier activityLogAlertResourceId = ActivityLogAlertResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, activityLogAlertName);
ActivityLogAlertResource activityLogAlert = client.GetActivityLogAlertResource(activityLogAlertResourceId);

// invoke the operation
ActivityLogAlertPatch patch = new ActivityLogAlertPatch()
{
    Tags =
    {
    ["key1"] = "value1",
    ["key2"] = "value2",
    },
    IsEnabled = false,
};
ActivityLogAlertResource result = await activityLogAlert.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ActivityLogAlertData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 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	指示操作失败原因的错误消息。

通过

Activity Log Alerts - Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Patch an Activity Log Alert rule

示例请求

示例响应

定义

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

AlertRulePatchObject

ErrorResponse

其他资源