Activity Log Alerts - Update

Service:

Monitor

API-versie:

2020-10-01

Updates 'tags' en 'ingeschakeld' velden in een bestaande waarschuwingsregel. Deze methode wordt gebruikt om de waarschuwingsregeltags bij te werken en om de waarschuwingsregel in of uit te schakelen. Als u andere velden wilt bijwerken, gebruikt u de bewerking CreateOrUpdate.

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

URI-parameters

Name	In	Vereist	Type	Description
activityLogAlertName	path	True	string	De naam van de waarschuwingsregel voor het activiteitenlogboek.
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
properties.enabled	boolean	Geeft aan of deze waarschuwingsregel voor activiteitenlogboeken is ingeschakeld. Als een waarschuwingsregel voor activiteitenlogboeken niet is ingeschakeld, worden geen van de acties geactiveerd.
tags	object	De resourcetags

Antwoorden

Name	Type	Description
200 OK	ActivityLogAlertResource	Een bestaande waarschuwingsregel voor activiteitenlogboeken is bijgewerkt.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Patch an Activity Log Alert rule

Voorbeeldaanvraag

HTTP

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

Java

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

Go

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

JavaScript

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

dotnet

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

Voorbeeldrespons

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

Definities

Name	Description
ActionGroup	Een aanwijzer naar een Azure-actiegroep.
ActionList	Een lijst met waarschuwingsregelacties voor activiteitenlogboeken.
ActivityLogAlertResource	Een resource voor waarschuwingsregel voor activiteitenlogboeken.
AlertRuleAllOfCondition	Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan wanneer aan alle lidvoorwaarden wordt voldaan.
AlertRuleAnyOfOrLeafCondition	Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan wanneer aan alle lidvoorwaarden wordt voldaan. Elke voorwaarde kan een van de volgende typen hebben: Belangrijk: elk type heeft een unieke subset van eigenschappen. Eigenschappen van verschillende typen KUNNEN NIET in één voorwaarde bestaan. Bladvoorwaarde: moet 'veld' bevatten en 'is gelijk aan' of 'containsAny'. Houd er rekening mee dat 'anyOf' niet mag worden ingesteld in een bladvoorwaarde. AnyOf Condition- mag alleen 'anyOf' bevatten (dit is een matrix van Bladvoorwaarden). Houd er rekening mee dat 'field', 'equals' en 'containsAny' niet mogen worden ingesteld in een AnyOf-voorwaarde.
AlertRuleLeafCondition	Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan door het veld en de waarde van een gebeurtenis in een activiteitenlogboek te vergelijken. Deze voorwaarde moet 'veld' bevatten en 'is gelijk aan' of 'containsAny'.
AlertRulePatchObject	Een activiteitslogboekwaarschuwingsregelobject voor de hoofdtekst van patchbewerkingen.
ErrorResponse	Het antwoord op de fout.

ActionGroup

Een aanwijzer naar een Azure-actiegroep.

Name	Type	Description
actionGroupId	string	De resource-id van de actiegroep. Dit mag niet null of leeg zijn.
webhookProperties	object	de woordenlijst met aangepaste eigenschappen die moeten worden opgenomen in de postbewerking. Deze gegevens worden toegevoegd aan de nettolading van de webhook.

ActionList

Een lijst met waarschuwingsregelacties voor activiteitenlogboeken.

Name	Type	Description
actionGroups	ActionGroup[]	De lijst met actiegroepen.

ActivityLogAlertResource

Een resource voor waarschuwingsregel voor activiteitenlogboeken.

Name	Type	Default value	Description
id	string		De resource-id.
location	string	global	De locatie van de resource. Waarschuwingsregels voor Azure-activiteitenlogboeken worden ondersteund in de regio's Algemeen, Europa - west en Europa - noord.
name	string		De naam van de resource.
properties.actions	ActionList		De acties die worden geactiveerd wanneer aan de voorwaarde wordt voldaan.
properties.condition	AlertRuleAllOfCondition		De voorwaarde die ervoor zorgt dat deze waarschuwing wordt geactiveerd.
properties.description	string		Een beschrijving van deze waarschuwingsregel voor activiteitenlogboeken.
properties.enabled	boolean	True	Geeft aan of deze waarschuwingsregel voor activiteitenlogboeken is ingeschakeld. Als een waarschuwingsregel voor activiteitenlogboeken niet is ingeschakeld, worden geen van de acties geactiveerd.
properties.scopes	string[]		Een lijst met resource-id's die als voorvoegsels worden gebruikt. De waarschuwing is alleen van toepassing op activiteitenlogboekgebeurtenissen met resource-id's die onder een van deze voorvoegsels vallen. Deze lijst moet ten minste één item bevatten.
tags	object		De tags van de resource.
type	string		Het type resource.

AlertRuleAllOfCondition

Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan wanneer aan alle lidvoorwaarden wordt voldaan.

Name	Type	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	De lijst met regels voor waarschuwingen voor activiteitenlogboeken.

AlertRuleAnyOfOrLeafCondition

Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan wanneer aan alle lidvoorwaarden wordt voldaan. Elke voorwaarde kan een van de volgende typen hebben: Belangrijk: elk type heeft een unieke subset van eigenschappen. Eigenschappen van verschillende typen KUNNEN NIET in één voorwaarde bestaan.

• Bladvoorwaarde: moet 'veld' bevatten en 'is gelijk aan' of 'containsAny'. Houd er rekening mee dat 'anyOf' niet mag worden ingesteld in een bladvoorwaarde.
• AnyOf Condition- mag alleen 'anyOf' bevatten (dit is een matrix van Bladvoorwaarden). Houd er rekening mee dat 'field', 'equals' en 'containsAny' niet mogen worden ingesteld in een AnyOf-voorwaarde.

Name	Type	Description
anyOf	AlertRuleLeafCondition[]	Een waarschuwingsregel voor activiteitenlogboek 'anyOf'-voorwaarde. Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan wanneer aan ten minste één van de lidbladvoorwaarden wordt voldaan.
containsAny	string[]	De waarde van het veld van de gebeurtenis wordt vergeleken met de waarden in deze matrix (niet hoofdlettergevoelig) om te bepalen of aan de voorwaarde is voldaan.
equals	string	De waarde van het veld van de gebeurtenis wordt vergeleken met deze waarde (niet hoofdlettergevoelig) om te bepalen of aan de voorwaarde wordt voldaan.
field	string	De naam van het veld van de gebeurtenis activiteitenlogboek dat door deze voorwaarde wordt onderzocht. De mogelijke waarden voor dit veld zijn (niet hoofdlettergevoelig): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' of iets dat begint met 'properties'.

AlertRuleLeafCondition

Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan door het veld en de waarde van een gebeurtenis in een activiteitenlogboek te vergelijken. Deze voorwaarde moet 'veld' bevatten en 'is gelijk aan' of 'containsAny'.

Name	Type	Description
containsAny	string[]	De waarde van het veld van de gebeurtenis wordt vergeleken met de waarden in deze matrix (niet hoofdlettergevoelig) om te bepalen of aan de voorwaarde is voldaan.
equals	string	De waarde van het veld van de gebeurtenis wordt vergeleken met deze waarde (niet hoofdlettergevoelig) om te bepalen of aan de voorwaarde wordt voldaan.
field	string	De naam van het veld van de gebeurtenis activiteitenlogboek dat door deze voorwaarde wordt onderzocht. De mogelijke waarden voor dit veld zijn (niet hoofdlettergevoelig): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' of iets dat begint met 'properties'.

AlertRulePatchObject

Een activiteitslogboekwaarschuwingsregelobject voor de hoofdtekst van patchbewerkingen.

Name	Type	Default value	Description
properties.enabled	boolean	True	Geeft aan of deze waarschuwingsregel voor activiteitenlogboeken is ingeschakeld. Als een waarschuwingsregel voor activiteitenlogboeken niet is ingeschakeld, worden geen van de acties geactiveerd.
tags	object		De resourcetags

ErrorResponse

Het antwoord op de fout.

Name	Type	Description
code	string	De foutcode.
message	string	Het foutbericht dat aangeeft waarom de bewerking is mislukt.