Activity Log Alerts - Update

Referenz

Dienst:: Monitor

API-Version:: 2020-10-01

Aktualisiert die Felder "Tags" und "aktiviert" in einer vorhandenen Warnungsregel. Diese Methode wird verwendet, um die Warnungsregeltags zu aktualisieren und die Warnungsregel zu aktivieren oder zu deaktivieren. Verwenden Sie zum Aktualisieren anderer Felder den CreateOrUpdate-Vorgang.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
activityLogAlertName	path	True	string	Der Name der Regel "Aktivitätsprotokollbenachrichtigung".
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.enabled	boolean	Gibt an, ob diese Aktivitätsprotokollbenachrichtigungsregel aktiviert ist. Wenn eine Aktivitätsprotokollbenachrichtigungsregel nicht aktiviert ist, wird keine der zugehörigen Aktionen aktiviert.
tags	object	Die Ressourcentags

Antworten

Name	Typ	Beschreibung
200 OK	ActivityLogAlertResource	Eine vorhandene Warnungsregel für das Aktivitätsprotokoll wurde erfolgreich aktualisiert.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Patch an Activity Log Alert rule

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
ActionGroup	Ein Zeiger auf eine Azure Action Group.
ActionList	Eine Liste der Regelaktionen im Aktivitätsprotokoll.
ActivityLogAlertResource	Eine Regelressource für Aktivitätsprotokollbenachrichtigungen.
AlertRuleAllOfCondition	Eine Regelbedingung für die Aktivitätsprotokollbenachrichtigung, die erfüllt ist, wenn alle Memberbedingungen erfüllt sind.
AlertRuleAnyOfOrLeafCondition	Eine Regelbedingung für die Aktivitätsprotokollbenachrichtigung, die erfüllt ist, wenn alle Memberbedingungen erfüllt sind. Jede Bedingung kann von einem der folgenden Typen sein: Wichtig: Jeder Typ verfügt über eine eindeutige Teilmenge von Eigenschaften. Eigenschaften aus unterschiedlichen Typen KÖNNEN in einer Bedingung nicht vorhanden sein. Blattbedingung - muss "Feld" und entweder "gleich" oder "containsAny" enthalten. Bitte beachten Sie, dass "anyOf" nicht in einer Blattbedingung festgelegt werden. AnyOf Condition - darf nur "anyOf" (ein Array von Blattbedingungen) enthalten. Bitte beachten Sie, dass "Field", "equals" und "containsAny" nicht in einer AnyOf-Bedingung festgelegt werden.
AlertRuleLeafCondition	Eine Regelbedingung des Aktivitätsprotokolls, die durch Vergleichen des Felds und des Werts eines Aktivitätsprotokollereignisses erfüllt wird. Diese Bedingung muss "Field" und entweder "equals" oder "containsAny" enthalten.
AlertRulePatchObject	Ein Regelobjekt des Aktivitätsprotokolls für den Textkörper von Patchvorgängen.
ErrorResponse	Die Fehlerantwort.

ActionGroup

Objekt

Ein Zeiger auf eine Azure Action Group.

Name	Typ	Beschreibung
actionGroupId	string	Die Ressourcen-ID der Aktionsgruppe. Dies darf nicht null oder leer sein.
webhookProperties	object	das Wörterbuch der benutzerdefinierten Eigenschaften, die in den Beitragsvorgang aufgenommen werden sollen. Diese Daten werden an die Webhook-Nutzlast angefügt.

ActionList

Objekt

Eine Liste der Regelaktionen im Aktivitätsprotokoll.

Name	Typ	Beschreibung
actionGroups	ActionGroup[]	Die Liste der Aktionsgruppen.

ActivityLogAlertResource

Objekt

Eine Regelressource für Aktivitätsprotokollbenachrichtigungen.

Name	Typ	Standardwert	Beschreibung
id	string		Die Ressourcen-ID.
location	string	global	Der Standort der Ressource. Azure Activity Log Alert rules are supported on Global, West Europe and North Europe regions.
name	string		Der Name der Ressource.
properties.actions	ActionList		Die Aktionen, die aktiviert werden, wenn die Bedingung erfüllt ist.
properties.condition	AlertRuleAllOfCondition		Die Bedingung, die dazu führt, dass diese Warnung aktiviert wird.
properties.description	string		Eine Beschreibung dieser Warnungsregel für das Aktivitätsprotokoll.
properties.enabled	boolean	True	Gibt an, ob diese Aktivitätsprotokollbenachrichtigungsregel aktiviert ist. Wenn eine Aktivitätsprotokollbenachrichtigungsregel nicht aktiviert ist, wird keine der zugehörigen Aktionen aktiviert.
properties.scopes	string[]		Eine Liste der Ressourcen-IDs, die als Präfixe verwendet werden. Die Warnung gilt nur für Aktivitätsprotokollereignisse mit Ressourcen-IDs, die unter eines dieser Präfixe fallen. Diese Liste muss mindestens ein Element enthalten.
tags	object		Die Tags der Ressource.
type	string		Der Typ der Ressource.

AlertRuleAllOfCondition

Objekt

Eine Regelbedingung für die Aktivitätsprotokollbenachrichtigung, die erfüllt ist, wenn alle Memberbedingungen erfüllt sind.

Name	Typ	Beschreibung
allOf	AlertRuleAnyOfOrLeafCondition[]	Die Liste der Regelbedingungen für Aktivitätsprotokollbenachrichtigungen.

AlertRuleAnyOfOrLeafCondition

Objekt

Eine Regelbedingung für die Aktivitätsprotokollbenachrichtigung, die erfüllt ist, wenn alle Memberbedingungen erfüllt sind. Jede Bedingung kann von einem der folgenden Typen sein: Wichtig: Jeder Typ verfügt über eine eindeutige Teilmenge von Eigenschaften. Eigenschaften aus unterschiedlichen Typen KÖNNEN in einer Bedingung nicht vorhanden sein.

Blattbedingung - muss "Feld" und entweder "gleich" oder "containsAny" enthalten. Bitte beachten Sie, dass "anyOf" nicht in einer Blattbedingung festgelegt werden.
AnyOf Condition - darf nur "anyOf" (ein Array von Blattbedingungen) enthalten. Bitte beachten Sie, dass "Field", "equals" und "containsAny" nicht in einer AnyOf-Bedingung festgelegt werden.

Name	Typ	Beschreibung
anyOf	AlertRuleLeafCondition[]	Eine Aktivitätsprotokollbenachrichtigungsregel "anyOf". Eine Regelbedingung für die Aktivitätsprotokollbenachrichtigung, die erfüllt ist, wenn mindestens eine seiner Memberblattbedingungen erfüllt ist.
containsAny	string[]	Der Wert des Felds des Ereignisses wird mit den Werten in diesem Array (Groß-/Kleinschreibung) verglichen, um festzustellen, ob die Bedingung erfüllt ist.
equals	string	Der Wert des Felds des Ereignisses wird mit diesem Wert (Groß-/Kleinschreibung) verglichen, um festzustellen, ob die Bedingung erfüllt ist.
field	string	Der Name des Felds "Aktivitätsprotokoll", das diese Bedingung untersucht. Die möglichen Werte für dieses Feld sind (Groß-/Kleinschreibung wird nicht beachtet): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' oder alles, was mit 'properties' beginnt.

AlertRuleLeafCondition

Objekt

Eine Regelbedingung des Aktivitätsprotokolls, die durch Vergleichen des Felds und des Werts eines Aktivitätsprotokollereignisses erfüllt wird. Diese Bedingung muss "Field" und entweder "equals" oder "containsAny" enthalten.

Name	Typ	Beschreibung
containsAny	string[]	Der Wert des Felds des Ereignisses wird mit den Werten in diesem Array (Groß-/Kleinschreibung) verglichen, um festzustellen, ob die Bedingung erfüllt ist.
equals	string	Der Wert des Felds des Ereignisses wird mit diesem Wert (Groß-/Kleinschreibung) verglichen, um festzustellen, ob die Bedingung erfüllt ist.
field	string	Der Name des Felds "Aktivitätsprotokoll", das diese Bedingung untersucht. Die möglichen Werte für dieses Feld sind (Groß-/Kleinschreibung wird nicht beachtet): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' oder alles, was mit 'properties' beginnt.

AlertRulePatchObject

Objekt

Ein Regelobjekt des Aktivitätsprotokolls für den Textkörper von Patchvorgängen.

Name	Typ	Standardwert	Beschreibung
properties.enabled	boolean	True	Gibt an, ob diese Aktivitätsprotokollbenachrichtigungsregel aktiviert ist. Wenn eine Aktivitätsprotokollbenachrichtigungsregel nicht aktiviert ist, wird keine der zugehörigen Aktionen aktiviert.
tags	object		Die Ressourcentags

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

Freigeben über

Activity Log Alerts - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Patch an Activity Log Alert rule

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

AlertRulePatchObject

ErrorResponse

Zusätzliche Ressourcen