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
Authorization URL (承認 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	すべてのメンバー条件が満たされたときに満たされるアクティビティログアラートルールの条件。各条件には、次のいずれかの型を指定できます。重要: 各型には、プロパティの一意のサブセットがあります。異なる型のプロパティは、1 つの条件に存在できません。リーフ条件 - 'field' と 'equals' または 'containsAny' を含める必要があります。リーフ条件で 'anyOf' を設定しないでください* 。* AnyOf 条件 - 'anyOf' (リーフ条件の配列) のみを含める必要があります。 AnyOf 条件では、'field'、'equals' および 'containsAny' を設定しないでください* 。*
AlertRuleLeafCondition	アクティビティログイベントのフィールドと値を比較することによって満たされるアクティビティログアラートルールの条件。この条件には、'field' と 'equals' または 'containsAny' が含まれている必要があります。
AlertRulePatchObject	パッチ操作の本文のアクティビティログアラートルールオブジェクト。
ErrorResponse	エラー応答。

ActionGroup

Azure アクショングループへのポインター。

名前	型	説明
actionGroupId	string	アクショングループのリソース ID。 null または空にすることはできません。
webhookProperties	object	post 操作に含めるカスタムプロパティのディクショナリ。これらのデータは 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 を持つアクティビティログイベントにのみ適用されます。このリストには、少なくとも 1 つの項目が含まれている必要があります。
tags	object		リソースのタグ。
type	string		リソースの型。

AlertRuleAllOfCondition

すべてのメンバー条件が満たされたときに満たされるアクティビティログアラートルールの条件。

名前	型	説明
allOf	AlertRuleAnyOfOrLeafCondition[]	アクティビティログアラートルールの条件の一覧。

AlertRuleAnyOfOrLeafCondition

すべてのメンバー条件が満たされたときに満たされるアクティビティログアラートルールの条件。各条件には、次のいずれかの型を指定できます。重要: 各型には、プロパティの一意のサブセットがあります。異なる型のプロパティは、1 つの条件に存在できません。

リーフ条件 - 'field' と 'equals' または 'containsAny' を含める必要があります。 リーフ条件で 'anyOf' を設定 しないでください 。
AnyOf 条件 - 'anyOf' (リーフ条件の配列) のみを 含める必要があります。 AnyOf 条件では、'field'、'equals' および 'containsAny' を設定 しないでください 。

名前	型	説明
anyOf	AlertRuleLeafCondition[]	アクティビティログアラートルール 'anyOf' 条件。メンバーリーフ条件の少なくとも 1 つが満たされたときに満たされるアクティビティログアラートルールの条件。
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

その他のリソース