Activity Log Alerts - Update

Odwołanie

Usługa:: Monitor

Wersja interfejsu API:: 2020-10-01

Aktualizacje pola "tags" i "enabled" w istniejącej regule alertu. Ta metoda służy do aktualizowania tagów reguły alertu i włączania lub wyłączania reguły alertu. Aby zaktualizować inne pola, użyj operacji CreateOrUpdate.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
activityLogAlertName	path	True	string	Nazwa reguły alertu dziennika aktywności.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
properties.enabled	boolean	Wskazuje, czy ta reguła alertu dziennika aktywności jest włączona. Jeśli reguła alertu dziennika aktywności nie jest włączona, żadna z jej akcji nie zostanie aktywowana.
tags	object	Tagi zasobów

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ActivityLogAlertResource	Istniejąca reguła alertu dziennika aktywności została pomyślnie zaktualizowana.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Patch an Activity Log Alert rule

Przykładowe żądanie

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Monitor;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;

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

Przykładowa odpowiedź

Kod stanu:: 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."
  }
}

Definicje

Nazwa	Opis
ActionGroup	Wskaźnik do grupy akcji platformy Azure.
ActionList	Lista akcji reguły alertu dziennika aktywności.
ActivityLogAlertResource	Zasób reguły alertu dziennika aktywności.
AlertRuleAllOfCondition	Warunek reguły alertu dziennika aktywności, który jest spełniony po spełnieniu wszystkich warunków członkowskich.
AlertRuleAnyOfOrLeafCondition	Warunek reguły alertu dziennika aktywności, który jest spełniony po spełnieniu wszystkich warunków członkowskich. Każdy warunek może być jednym z następujących typów: Ważne: każdy typ ma unikatowy podzbiór właściwości. Właściwości z różnych typów NIE MOGĄ istnieć w jednym warunku. Warunek liścia — musi zawierać pole i "równa się" lub "containsAny". Pamiętaj, że parametr "anyOf" nie* powinien być ustawiony w warunku liścia.* AnyOf Condition — musi zawierać tylko "anyOf" (czyli tablicę warunków liścia). Pamiętaj, że parametr "field", "equals" i "containsAny" nie* powinien być ustawiony w warunku AnyOf.*
AlertRuleLeafCondition	Warunek reguły alertu dziennika aktywności, który jest spełniony, porównując pole i wartość zdarzenia dziennika aktywności. Ten warunek musi zawierać wartość "field" i "equals" lub "containsAny".
AlertRulePatchObject	Obiekt reguły alertu dziennika aktywności dla treści operacji poprawek.
ErrorResponse	Odpowiedź na błąd.

ActionGroup

Wskaźnik do grupy akcji platformy Azure.

Nazwa	Typ	Opis
actionGroupId	string	Identyfikator zasobu grupy akcji. Nie może to być wartość null ani być pusta.
webhookProperties	object	słownik właściwości niestandardowych do uwzględnienia w operacji po operacji. Te dane są dołączane do ładunku elementu webhook.

ActionList

Lista akcji reguły alertu dziennika aktywności.

Nazwa	Typ	Opis
actionGroups	ActionGroup[]	Lista grup akcji.

ActivityLogAlertResource

Zasób reguły alertu dziennika aktywności.

Nazwa	Typ	Domyślna wartość	Opis
id	string		Identyfikator zasobu.
location	string	global	Lokalizacja zasobu. Reguły alertów dziennika aktywności platformy Azure są obsługiwane w regionach Global, Europa Zachodnia i Europa Północna.
name	string		Nazwa zasobu.
properties.actions	ActionList		Akcje, które zostaną aktywowane po spełnieniu warunku.
properties.condition	AlertRuleAllOfCondition		Warunek, który spowoduje aktywowanie tego alertu.
properties.description	string		Opis tej reguły alertu dziennika aktywności.
properties.enabled	boolean	True	Wskazuje, czy ta reguła alertu dziennika aktywności jest włączona. Jeśli reguła alertu dziennika aktywności nie jest włączona, żadna z jej akcji nie zostanie aktywowana.
properties.scopes	string[]		Lista identyfikatorów zasobów, które będą używane jako prefiksy. Alert będzie stosowany tylko do zdarzeń dziennika aktywności z identyfikatorami zasobów, które należą do jednego z tych prefiksów. Ta lista musi zawierać co najmniej jeden element.
tags	object		Tagi zasobu.
type	string		Typ zasobu.

AlertRuleAllOfCondition

Warunek reguły alertu dziennika aktywności, który jest spełniony po spełnieniu wszystkich warunków członkowskich.

Nazwa	Typ	Opis
allOf	AlertRuleAnyOfOrLeafCondition[]	Lista warunków reguły alertu dziennika aktywności.

AlertRuleAnyOfOrLeafCondition

Warunek reguły alertu dziennika aktywności, który jest spełniony po spełnieniu wszystkich warunków członkowskich. Każdy warunek może być jednym z następujących typów: Ważne: każdy typ ma unikatowy podzbiór właściwości. Właściwości z różnych typów NIE MOGĄ istnieć w jednym warunku.

Warunek liścia — musi zawierać pole i "równa się" lub "containsAny". Pamiętaj, że parametr "anyOf" nie powinien być ustawiony w warunku liścia.
AnyOf Condition — musi zawierać tylko "anyOf" (czyli tablicę warunków liścia). Pamiętaj, że parametr "field", "equals" i "containsAny" nie powinien być ustawiony w warunku AnyOf.

Nazwa	Typ	Opis
anyOf	AlertRuleLeafCondition[]	Warunek alertu dziennika aktywności "anyOf". Warunek reguły alertu dziennika aktywności, który jest spełniony po spełnieniu co najmniej jednego z warunków liścia członkowskiego.
containsAny	string[]	Wartość pola zdarzenia zostanie porównana z wartościami w tej tablicy (bez uwzględniania wielkości liter), aby określić, czy warunek jest spełniony.
equals	string	Wartość pola zdarzenia zostanie porównana z tą wartością (bez uwzględniania wielkości liter), aby określić, czy warunek jest spełniony.
field	string	Nazwa pola zdarzenia dziennika aktywności, które zostanie przeanalizowane przez ten warunek. Możliwe wartości tego pola to (bez uwzględniania wielkości liter): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" lub dowolny element rozpoczynający się od właściwości.

AlertRuleLeafCondition

Warunek reguły alertu dziennika aktywności, który jest spełniony, porównując pole i wartość zdarzenia dziennika aktywności. Ten warunek musi zawierać wartość "field" i "equals" lub "containsAny".

Nazwa	Typ	Opis
containsAny	string[]	Wartość pola zdarzenia zostanie porównana z wartościami w tej tablicy (bez uwzględniania wielkości liter), aby określić, czy warunek jest spełniony.
equals	string	Wartość pola zdarzenia zostanie porównana z tą wartością (bez uwzględniania wielkości liter), aby określić, czy warunek jest spełniony.
field	string	Nazwa pola zdarzenia dziennika aktywności, które zostanie przeanalizowane przez ten warunek. Możliwe wartości tego pola to (bez uwzględniania wielkości liter): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" lub dowolny element rozpoczynający się od właściwości.

AlertRulePatchObject

Obiekt reguły alertu dziennika aktywności dla treści operacji poprawek.

Nazwa	Typ	Domyślna wartość	Opis
properties.enabled	boolean	True	Wskazuje, czy ta reguła alertu dziennika aktywności jest włączona. Jeśli reguła alertu dziennika aktywności nie jest włączona, żadna z jej akcji nie zostanie aktywowana.
tags	object		Tagi zasobów

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

Udostępnij za pośrednictwem

Activity Log Alerts - Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Patch an Activity Log Alert rule

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

AlertRulePatchObject

ErrorResponse

Dodatkowe zasoby