Activity Log Alerts - Update

Referensi

Layanan:: Monitor

Versi API:: 2020-10-01

Memperbarui bidang 'tag' dan 'diaktifkan' dalam aturan Pemberitahuan yang ada. Metode ini digunakan untuk memperbarui tag Aturan pemberitahuan, dan untuk mengaktifkan atau menonaktifkan aturan Pemberitahuan. Untuk memperbarui bidang lain, gunakan operasi CreateOrUpdate.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
activityLogAlertName	path	True	string	Nama aturan Pemberitahuan Log Aktivitas.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.enabled	boolean	Menunjukkan apakah aturan Pemberitahuan Log Aktivitas ini diaktifkan. Jika aturan Pemberitahuan Log Aktivitas tidak diaktifkan, maka tidak ada tindakannya yang akan diaktifkan.
tags	object	Tag sumber daya

Respons

Nama	Jenis	Deskripsi
200 OK	ActivityLogAlertResource	Aturan Pemberitahuan Log Aktivitas yang ada berhasil diperbarui.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Patch an Activity Log Alert rule

Permintaan sampel

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

Respon sampel

Kode status:: 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."
  }
}

Definisi

Nama	Deskripsi
ActionGroup	Penunjuk ke Grup Tindakan Azure.
ActionList	Daftar tindakan aturan Pemberitahuan Log Aktivitas.
ActivityLogAlertResource	Sumber daya aturan Pemberitahuan Log Aktivitas.
AlertRuleAllOfCondition	Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi.
AlertRuleAnyOfOrLeafCondition	Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi. Setiap kondisi dapat berupa salah satu jenis berikut: Penting : Setiap jenis memiliki subset properti yang unik. Properti dari berbagai jenis TIDAK DAPAT ada dalam satu kondisi. Kondisi Daun - harus berisi 'bidang' dan 'sama dengan' atau 'containsAny'. Harap dicatat, 'anyOf' harus tidak* diatur dalam Kondisi Daun.* Kondisi AnyOf - harus berisi hanya 'anyOf' (yang merupakan larik Kondisi Daun). Harap dicatat, 'field', 'equals' dan 'containsAny' harus tidak* diatur dalam Kondisi AnyOf.*
AlertRuleLeafCondition	Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi dengan membandingkan bidang dan nilai peristiwa Log Aktivitas. Kondisi ini harus berisi 'bidang' dan 'sama dengan' atau 'containsAny'.
AlertRulePatchObject	Objek aturan Pemberitahuan Log Aktivitas untuk isi operasi patch.
ErrorResponse	Respons kesalahan.

ActionGroup

Objek

Penunjuk ke Grup Tindakan Azure.

Nama	Jenis	Deskripsi
actionGroupId	string	ID sumber daya Grup Tindakan. Ini tidak boleh null atau kosong.
webhookProperties	object	kamus properti kustom untuk disertakan dengan operasi pasca. Data ini ditambahkan ke payload webhook.

ActionList

Objek

Daftar tindakan aturan Pemberitahuan Log Aktivitas.

Nama	Jenis	Deskripsi
actionGroups	ActionGroup[]	Daftar Grup Tindakan.

ActivityLogAlertResource

Objek

Sumber daya aturan Pemberitahuan Log Aktivitas.

Nama	Jenis	Nilai default	Deskripsi
id	string		Id sumber daya.
location	string	global	Lokasi sumber daya. Aturan Pemberitahuan Log Aktivitas Azure didukung di wilayah Global, Eropa Barat, dan Eropa Utara.
name	string		Nama sumber daya.
properties.actions	ActionList		Tindakan yang akan diaktifkan saat kondisi terpenuhi.
properties.condition	AlertRuleAllOfCondition		Kondisi yang akan menyebabkan pemberitahuan ini diaktifkan.
properties.description	string		Deskripsi aturan Pemberitahuan Log Aktivitas ini.
properties.enabled	boolean	True	Menunjukkan apakah aturan Pemberitahuan Log Aktivitas ini diaktifkan. Jika aturan Pemberitahuan Log Aktivitas tidak diaktifkan, maka tidak ada tindakannya yang akan diaktifkan.
properties.scopes	string[]		Daftar ID sumber daya yang akan digunakan sebagai awalan. Pemberitahuan hanya akan berlaku untuk peristiwa Log Aktivitas dengan ID sumber daya yang termasuk dalam salah satu awalan ini. Daftar ini harus menyertakan setidaknya satu item.
tags	object		Tag sumber daya.
type	string		Jenis sumber daya.

AlertRuleAllOfCondition

Objek

Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi.

Nama	Jenis	Deskripsi
allOf	AlertRuleAnyOfOrLeafCondition[]	Daftar kondisi aturan Pemberitahuan Log Aktivitas.

AlertRuleAnyOfOrLeafCondition

Objek

Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi. Setiap kondisi dapat berupa salah satu jenis berikut: Penting : Setiap jenis memiliki subset properti yang unik. Properti dari berbagai jenis TIDAK DAPAT ada dalam satu kondisi.

Kondisi Daun - harus berisi 'bidang' dan 'sama dengan' atau 'containsAny'. Harap dicatat, 'anyOf' harus tidak diatur dalam Kondisi Daun.
Kondisi AnyOf - harus berisi hanya 'anyOf' (yang merupakan larik Kondisi Daun). Harap dicatat, 'field', 'equals' dan 'containsAny' harus tidak diatur dalam Kondisi AnyOf.

Nama	Jenis	Deskripsi
anyOf	AlertRuleLeafCondition[]	Aturan Pemberitahuan Log Aktivitas kondisi 'anyOf'. Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi ketika setidaknya salah satu kondisi daun anggotanya terpenuhi.
containsAny	string[]	Nilai bidang peristiwa akan dibandingkan dengan nilai dalam array ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.
equals	string	Nilai bidang peristiwa akan dibandingkan dengan nilai ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.
field	string	Nama bidang peristiwa Log Aktivitas yang akan diperiksa kondisi ini. Nilai yang mungkin untuk bidang ini adalah (tidak peka huruf besar/kecil): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', atau apa pun yang dimulai dengan 'properti'.

AlertRuleLeafCondition

Objek

Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi dengan membandingkan bidang dan nilai peristiwa Log Aktivitas. Kondisi ini harus berisi 'bidang' dan 'sama dengan' atau 'containsAny'.

Nama	Jenis	Deskripsi
containsAny	string[]	Nilai bidang peristiwa akan dibandingkan dengan nilai dalam array ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.
equals	string	Nilai bidang peristiwa akan dibandingkan dengan nilai ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.
field	string	Nama bidang peristiwa Log Aktivitas yang akan diperiksa kondisi ini. Nilai yang mungkin untuk bidang ini adalah (tidak peka huruf besar/kecil): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', atau apa pun yang dimulai dengan 'properti'.

AlertRulePatchObject

Objek

Objek aturan Pemberitahuan Log Aktivitas untuk isi operasi patch.

Nama	Jenis	Nilai default	Deskripsi
properties.enabled	boolean	True	Menunjukkan apakah aturan Pemberitahuan Log Aktivitas ini diaktifkan. Jika aturan Pemberitahuan Log Aktivitas tidak diaktifkan, maka tidak ada tindakannya yang akan diaktifkan.
tags	object		Tag sumber daya

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

Bagikan melalui

Activity Log Alerts - Update

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

Patch an Activity Log Alert rule

Permintaan sampel

Respon sampel

Definisi

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

AlertRulePatchObject

ErrorResponse

Sumber Daya Tambahan: