Activity Log Alerts - Update

參考

服務:: Monitor

API 版本:: 2020-10-01

更新現有警示規則中的 [標記] 和 [已啟用] 欄位。這個方法可用來更新警示規則標籤，以及啟用或停用警示規則。若要更新其他欄位，請使用 CreateOrUpdate 作業。

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

URI 參數

名稱	位於	必要	類型	Description
activityLogAlertName	path	True	string	活動記錄警示規則的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
properties.enabled	boolean	指出是否啟用此活動記錄警示規則。如果未啟用活動記錄警示規則，則不會啟動其任何動作。
tags	object	資源標籤

回應

名稱	類型	Description
200 OK	ActivityLogAlertResource	已成功更新現有的活動記錄警示規則。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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.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."
  }
}

定義

名稱	Description
ActionGroup	Azure 動作群組的指標。
ActionList	活動記錄警示規則動作的清單。
ActivityLogAlertResource	活動記錄警示規則資源。
AlertRuleAllOfCondition	符合其所有成員條件時所符合的活動記錄警示規則條件。
AlertRuleAnyOfOrLeafCondition	符合其所有成員條件時所符合的活動記錄警示規則條件。每個條件可以是下列其中一種類型：重要：每個類型都有其唯一的屬性子集。不同類型的屬性不能存在於一個條件中。分葉條件 - 必須包含 'field' 和 'equals' 或 'containsAny'。請注意，'anyOf' 應該不要在分葉條件中設定。 AnyOf 條件 - 必須只包含 'anyOf' （這是分葉條件陣列）。請注意，'field'、'equals' 和 'containsAny' 應該不要在 AnyOf 條件中設定。
AlertRuleLeafCondition	藉由比較活動記錄事件的欄位和值，符合活動記錄警示規則條件。此條件必須包含『field』和 'equals' 或 'containsAny'。
AlertRulePatchObject	修補作業主體的活動記錄警示規則物件。
ErrorResponse	錯誤回應。

ActionGroup

Object

Azure 動作群組的指標。

名稱	類型	Description
actionGroupId	string	動作群組的資源標識碼。這不可以是 Null 或空白。
webhookProperties	object	要包含在後續作業中的自定義屬性字典。這些數據會附加至 Webhook 承載。

ActionList

Object

活動記錄警示規則動作的清單。

名稱	類型	Description
actionGroups	ActionGroup[]	動作群組的清單。

ActivityLogAlertResource

Object

活動記錄警示規則資源。

名稱	類型	預設值	Description
id	string		資源標識碼。
location	string	global	資源的位置。全域、西歐和北歐區域支援 Azure 活動記錄警示規則。
name	string		資源的名稱。
properties.actions	ActionList		符合條件時將會啟動的動作。
properties.condition	AlertRuleAllOfCondition		導致此警示啟動的條件。
properties.description	string		此活動記錄警示規則的描述。
properties.enabled	boolean	True	指出是否啟用此活動記錄警示規則。如果未啟用活動記錄警示規則，則不會啟動其任何動作。
properties.scopes	string[]		將做為前置詞的資源標識符清單。警示只會套用至資源標識碼低於下列其中一個前置詞的活動記錄事件。此清單必須包含至少一個專案。
tags	object		資源的標記。
type	string		資源的型別。

AlertRuleAllOfCondition

Object

符合其所有成員條件時所符合的活動記錄警示規則條件。

名稱	類型	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	活動記錄警示規則條件的清單。

AlertRuleAnyOfOrLeafCondition

Object

符合其所有成員條件時所符合的活動記錄警示規則條件。每個條件可以是下列其中一種類型：重要：每個類型都有其唯一的屬性子集。不同類型的屬性不能存在於一個條件中。

分葉條件 - 必須包含 'field' 和 'equals' 或 'containsAny'。 請注意，'anyOf' 應該不要在分葉條件中設定。
AnyOf 條件 - 必須只包含 'anyOf' （這是分葉條件陣列）。 請注意，'field'、'equals' 和 'containsAny' 應該不要在 AnyOf 條件中設定。

名稱	類型	Description
anyOf	AlertRuleLeafCondition[]	活動記錄警示規則『anyOf』條件。當至少符合其中一個成員分葉條件時，符合的活動記錄警示規則條件。
containsAny	string[]	事件欄位的值將會與此陣列中的值進行比較（不區分大小寫），以判斷是否符合條件。
equals	string	事件欄位的值將會與此值進行比較（不區分大小寫），以判斷是否符合條件。
field	string	此條件將檢查之活動記錄事件欄位的名稱。此字段的可能值為（不區分大小寫）：'resourceId'、'category'、'caller'、'level'、'operationName'、'resourceGroup'、'resourceProvider'、'status'、'subStatus'、'resourceType'或以 'properties' 開頭的任何專案。

AlertRuleLeafCondition

Object

藉由比較活動記錄事件的欄位和值，符合活動記錄警示規則條件。此條件必須包含『field』和 'equals' 或 'containsAny'。

名稱	類型	Description
containsAny	string[]	事件欄位的值將會與此陣列中的值進行比較（不區分大小寫），以判斷是否符合條件。
equals	string	事件欄位的值將會與此值進行比較（不區分大小寫），以判斷是否符合條件。
field	string	此條件將檢查之活動記錄事件欄位的名稱。此字段的可能值為（不區分大小寫）：'resourceId'、'category'、'caller'、'level'、'operationName'、'resourceGroup'、'resourceProvider'、'status'、'subStatus'、'resourceType'或以 'properties' 開頭的任何專案。

AlertRulePatchObject

Object

修補作業主體的活動記錄警示規則物件。

名稱	類型	預設值	Description
properties.enabled	boolean	True	指出是否啟用此活動記錄警示規則。如果未啟用活動記錄警示規則，則不會啟動其任何動作。
tags	object		資源標籤

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
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

其他資源