Activity Log Alerts - Update

Service:

Monitor

Version d'API:

2020-10-01

Mises à jour les champs « tags » et « enabled » dans une règle d’alerte existante. Cette méthode est utilisée pour mettre à jour les balises de règle d’alerte et pour activer ou désactiver la règle d’alerte. Pour mettre à jour d’autres champs, utilisez l’opération CreateOrUpdate.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
activityLogAlertName	path	True	string	Nom de la règle d’alerte de journal d’activité.
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.enabled	boolean	Indique si cette règle d’alerte de journal d’activité est activée. Si une règle d’alerte de journal d’activité n’est pas activée, aucune de ses actions n’est activée.
tags	object	Balises de ressource

Réponses

Nom	Type	Description
200 OK	ActivityLogAlertResource	Une règle d’alerte de journal d’activité existante a été correctement mise à jour.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Patch an Activity Log Alert rule

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
ActionGroup	Pointeur vers un groupe d’actions Azure.
ActionList	Liste des actions de règle d’alerte de journal d’activité.
ActivityLogAlertResource	Une ressource de règle d’alerte de journal d’activité.
AlertRuleAllOfCondition	Une condition de règle d’alerte de journal d’activité qui est remplie lorsque toutes ses conditions membres sont remplies.
AlertRuleAnyOfOrLeafCondition	Une condition de règle d’alerte de journal d’activité qui est remplie lorsque toutes ses conditions membres sont remplies. Chaque condition peut être de l’un des types suivants : Important : Chaque type a son sous-ensemble unique de propriétés. Les propriétés de différents types NE PEUVENT pas exister dans une seule condition. Condition feuille : doit contenir 'field' et 'equals' ou 'containsAny'. Notez que « anyOf » ne doit pas être défini dans une condition feuille. Condition AnyOf : doit contenir uniquement 'anyOf' (qui est un tableau de conditions feuille). Notez que « field », « equals » et « containsAny » ne doivent pas être définis dans une condition AnyOf.
AlertRuleLeafCondition	Condition de règle d’alerte de journal d’activité qui est remplie en comparant le champ et la valeur d’un événement de journal d’activité. Cette condition doit contenir 'field' et 'equals' ou 'containsAny'.
AlertRulePatchObject	Objet de règle d’alerte de journal d’activité pour le corps des opérations de correctif.
ErrorResponse	Réponse d’erreur.

ActionGroup

Pointeur vers un groupe d’actions Azure.

Nom	Type	Description
actionGroupId	string	ID de ressource du groupe d’actions. Il ne peut pas être null ou vide.
webhookProperties	object	dictionnaire de propriétés personnalisées à inclure dans l’opération de publication. Ces données sont ajoutées à la charge utile du webhook.

ActionList

Liste des actions de règle d’alerte de journal d’activité.

Nom	Type	Description
actionGroups	ActionGroup[]	Liste des groupes d’actions.

ActivityLogAlertResource

Une ressource de règle d’alerte de journal d’activité.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource.
location	string	global	Emplacement de la ressource. Les règles d’alerte de journal d’activité Azure sont prises en charge dans les régions Global, Europe Ouest et Europe Nord.
name	string		Nom de la ressource.
properties.actions	ActionList		Actions qui s’activeront lorsque la condition est remplie.
properties.condition	AlertRuleAllOfCondition		Condition à l’origine de l’activation de cette alerte.
properties.description	string		Description de cette règle d’alerte de journal d’activité.
properties.enabled	boolean	True	Indique si cette règle d’alerte de journal d’activité est activée. Si une règle d’alerte de journal d’activité n’est pas activée, aucune de ses actions n’est activée.
properties.scopes	string[]		Liste des ID de ressources qui seront utilisés comme préfixes. L’alerte s’applique uniquement aux événements du journal d’activité avec des ID de ressource qui relèvent de l’un de ces préfixes. Cette liste doit inclure au moins un élément.
tags	object		Balises de la ressource.
type	string		Type de la ressource.

AlertRuleAllOfCondition

Une condition de règle d’alerte de journal d’activité qui est remplie lorsque toutes ses conditions membres sont remplies.

Nom	Type	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	Liste des conditions de règle d’alerte de journal d’activité.

AlertRuleAnyOfOrLeafCondition

Une condition de règle d’alerte de journal d’activité qui est remplie lorsque toutes ses conditions membres sont remplies. Chaque condition peut être de l’un des types suivants : Important : Chaque type a son sous-ensemble unique de propriétés. Les propriétés de différents types NE PEUVENT pas exister dans une seule condition.

• Condition feuille : doit contenir 'field' et 'equals' ou 'containsAny'. Notez que « anyOf » ne doit pas être défini dans une condition feuille.
• Condition AnyOf : doit contenir uniquement 'anyOf' (qui est un tableau de conditions feuille). Notez que « field », « equals » et « containsAny » ne doivent pas être définis dans une condition AnyOf.

Nom	Type	Description
anyOf	AlertRuleLeafCondition[]	Une condition de règle d’alerte de journal d’activité « anyOf ». Une condition de règle d’alerte de journal d’activité qui est remplie quand au moins une de ses conditions feuille membres est remplie.
containsAny	string[]	La valeur du champ de l’événement sera comparée aux valeurs de ce tableau (ne respectant pas la casse) pour déterminer si la condition est remplie.
equals	string	La valeur du champ de l’événement sera comparée à cette valeur (ne respectant pas la casse) pour déterminer si la condition est remplie.
field	string	Nom du champ de l’événement du journal d’activité que cette condition examinera. Les valeurs possibles pour ce champ sont (ne respectant pas la casse) : 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', ou tout ce qui commence par 'properties'.

AlertRuleLeafCondition

Condition de règle d’alerte de journal d’activité qui est remplie en comparant le champ et la valeur d’un événement de journal d’activité. Cette condition doit contenir 'field' et 'equals' ou 'containsAny'.

Nom	Type	Description
containsAny	string[]	La valeur du champ de l’événement sera comparée aux valeurs de ce tableau (ne respectant pas la casse) pour déterminer si la condition est remplie.
equals	string	La valeur du champ de l’événement sera comparée à cette valeur (ne respectant pas la casse) pour déterminer si la condition est remplie.
field	string	Nom du champ de l’événement du journal d’activité que cette condition examinera. Les valeurs possibles pour ce champ sont (ne respectant pas la casse) : 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', ou tout ce qui commence par 'properties'.

AlertRulePatchObject

Objet de règle d’alerte de journal d’activité pour le corps des opérations de correctif.

Nom	Type	Valeur par défaut	Description
properties.enabled	boolean	True	Indique si cette règle d’alerte de journal d’activité est activée. Si une règle d’alerte de journal d’activité n’est pas activée, aucune de ses actions n’est activée.
tags	object		Balises de ressource

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
code	string	Code d'erreur.
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.