Activity Log Alerts - Update

Referensi

Service:: Monitor

API Version:: 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

Name	In	Required	Type	Description
activityLogAlertName	path	True	string	Nama aturan Pemberitahuan Log Aktivitas.
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Name	Type	Description
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

Name	Type	Description
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

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

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

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/tree/main/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()
	client, err := armmonitor.NewActivityLogAlertsClient("187f412d-1758-44d9-b052-169e2564721d", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.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)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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 = "187f412d-1758-44d9-b052-169e2564721d";
  const resourceGroupName = "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);
}

patchAnActivityLogAlertRule().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

Definisi

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' tidak* boleh diatur dalam Kondisi Daun.* Kondisi AnyOf -hanya boleh berisi 'anyOf' (yang merupakan array Kondisi Daun). Harap dicatat, 'field', 'equals' dan 'containsAny' tidak* boleh diatur dalam Kondisi AnyOf.*
AlertRuleLeafCondition	Kondisi aturan Pemberitahuan Log Aktivitas yang dipenuhi dengan membandingkan bidang dan nilai peristiwa Log Aktivitas. Kondisi ini harus berisi 'field' dan 'equals' atau 'containsAny'.
AlertRulePatchObject	Objek aturan Pemberitahuan Log Aktivitas untuk isi operasi patch.
ErrorResponse	Respons kesalahan.

ActionGroup

Penunjuk ke Grup Tindakan Azure.

Name	Type	Description
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

Daftar tindakan aturan Pemberitahuan Log Aktivitas.

Name	Type	Description
actionGroups	ActionGroup[]	Daftar Grup Tindakan.

ActivityLogAlertResource

Sumber daya aturan Pemberitahuan Log Aktivitas.

Name	Type	Default Value	Description
id	string		Id sumber daya.
location	string	global	Lokasi sumber daya. Karena Pemberitahuan Log Aktivitas Azure adalah layanan global, lokasi aturan harus selalu 'global'.
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

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

Name	Type	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	Daftar kondisi aturan Pemberitahuan Log Aktivitas.

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' tidak boleh diatur dalam Kondisi Daun.
Kondisi AnyOf -hanya boleh berisi 'anyOf' (yang merupakan array Kondisi Daun). Harap dicatat, 'field', 'equals' dan 'containsAny' tidak boleh diatur dalam Kondisi AnyOf.

Name	Type	Description
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 'properties'.

AlertRuleLeafCondition

Kondisi aturan Pemberitahuan Log Aktivitas yang dipenuhi dengan membandingkan bidang dan nilai peristiwa Log Aktivitas. Kondisi ini harus berisi 'field' dan 'equals' atau 'containsAny'.

Name	Type	Description
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 'properties'.

AlertRulePatchObject

Objek aturan Pemberitahuan Log Aktivitas untuk isi operasi patch.

Name	Type	Default Value	Description
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

Respons kesalahan.

Name	Type	Description
code	string	Kode kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.