Activity Log Alerts - Update

Servizio:

Monitor

Versione API:

2020-10-01

Aggiornamenti campi 'tags' e 'enabled' in una regola di avviso esistente. Questo metodo viene usato per aggiornare i tag delle regole di avviso e per abilitare o disabilitare la regola di avviso. Per aggiornare altri campi, utilizzare l'operazione CreateOrUpdate.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
activityLogAlertName	path	True	string	Nome della regola di avviso del log attività.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.enabled	boolean	Indica se questa regola di avviso del log attività è abilitata. Se una regola di avviso del log attività non è abilitata, nessuna delle relative azioni verrà attivata.
tags	object	Tag delle risorse

Risposte

Nome	Tipo	Descrizione
200 OK	ActivityLogAlertResource	Una regola di avviso del log attività esistente è stata aggiornata correttamente.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Patch an Activity Log Alert rule

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
ActionGroup	Puntatore a un gruppo di azioni di Azure.
ActionList	Elenco delle azioni delle regole di avviso del log attività.
ActivityLogAlertResource	Risorsa regola avviso log attività.
AlertRuleAllOfCondition	Condizione della regola di avviso del log attività soddisfatta quando vengono soddisfatte tutte le relative condizioni membro.
AlertRuleAnyOfOrLeafCondition	Condizione della regola di avviso del log attività soddisfatta quando vengono soddisfatte tutte le relative condizioni membro. Ogni condizione può essere di uno dei tipi seguenti: Importante: ogni tipo ha un sottoinsieme univoco di proprietà. Le proprietà di tipi diversi NON POSSONO esistere in una condizione. Condizione foglia: deve contenere 'field' e 'equals' o 'containsAny'. Si noti che 'anyOf' non deve essere impostato in una condizione foglia. AnyOf Condition: deve contenere solo 'anyOf', ovvero una matrice di condizioni foglia. Si noti che 'field', 'equals' e 'containsAny' non devono essere impostati in una condizione AnyOf.
AlertRuleLeafCondition	Condizione della regola di avviso del log attività soddisfatta confrontando il campo e il valore di un evento del log attività. Questa condizione deve contenere 'field' e 'equals' o 'containsAny'.
AlertRulePatchObject	Oggetto regola di avviso del log attività per il corpo delle operazioni patch.
ErrorResponse	Risposta di errore.

ActionGroup

Puntatore a un gruppo di azioni di Azure.

Nome	Tipo	Descrizione
actionGroupId	string	ID risorsa del gruppo di azioni. Non può essere null o vuoto.
webhookProperties	object	dizionario delle proprietà personalizzate da includere con l'operazione post. Questi dati vengono aggiunti al payload del webhook.

ActionList

Elenco delle azioni delle regole di avviso del log attività.

Nome	Tipo	Descrizione
actionGroups	ActionGroup[]	Elenco dei gruppi di azioni.

ActivityLogAlertResource

Risorsa regola avviso log attività.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID risorsa.
location	string	global	Il percorso della risorsa. Le regole di avviso del log attività di Azure sono supportate nelle aree Globali, Europa occidentale ed Europa settentrionale.
name	string		Nome della risorsa.
properties.actions	ActionList		Azioni che verranno attivate quando viene soddisfatta la condizione.
properties.condition	AlertRuleAllOfCondition		Condizione che causerà l'attivazione dell'avviso.
properties.description	string		Descrizione di questa regola di avviso del log attività.
properties.enabled	boolean	True	Indica se questa regola di avviso del log attività è abilitata. Se una regola di avviso del log attività non è abilitata, nessuna delle relative azioni verrà attivata.
properties.scopes	string[]		Elenco di ID risorsa che verranno usati come prefissi. L'avviso verrà applicato solo agli eventi del log attività con ID risorsa che rientrano in uno di questi prefissi. Questo elenco deve includere almeno un elemento.
tags	object		Tag della risorsa.
type	string		Tipo di risorsa.

AlertRuleAllOfCondition

Condizione della regola di avviso del log attività soddisfatta quando vengono soddisfatte tutte le relative condizioni membro.

Nome	Tipo	Descrizione
allOf	AlertRuleAnyOfOrLeafCondition[]	Elenco delle condizioni delle regole di avviso del log attività.

AlertRuleAnyOfOrLeafCondition

Condizione della regola di avviso del log attività soddisfatta quando vengono soddisfatte tutte le relative condizioni membro. Ogni condizione può essere di uno dei tipi seguenti: Importante: ogni tipo ha un sottoinsieme univoco di proprietà. Le proprietà di tipi diversi NON POSSONO esistere in una condizione.

• Condizione foglia: deve contenere 'field' e 'equals' o 'containsAny'. Si noti che 'anyOf' non deve essere impostato in una condizione foglia.
• AnyOf Condition: deve contenere solo 'anyOf', ovvero una matrice di condizioni foglia. Si noti che 'field', 'equals' e 'containsAny' non devono essere impostati in una condizione AnyOf.

Nome	Tipo	Descrizione
anyOf	AlertRuleLeafCondition[]	Una regola di avviso del log attività 'anyOf'. Condizione della regola di avviso del log attività soddisfatta quando vengono soddisfatte almeno una delle relative condizioni foglia membro.
containsAny	string[]	Il valore del campo dell'evento verrà confrontato con i valori di questa matrice (senza distinzione tra maiuscole e minuscole) per determinare se la condizione viene soddisfatta.
equals	string	Il valore del campo dell'evento verrà confrontato con questo valore (senza distinzione tra maiuscole e minuscole) per determinare se la condizione viene soddisfatta.
field	string	Nome del campo dell'evento del log attività che questa condizione esaminerà. I valori possibili per questo campo sono (senza distinzione tra maiuscole e minuscole): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', o qualsiasi elemento che inizia con 'properties'.

AlertRuleLeafCondition

Condizione della regola di avviso del log attività soddisfatta confrontando il campo e il valore di un evento del log attività. Questa condizione deve contenere 'field' e 'equals' o 'containsAny'.

Nome	Tipo	Descrizione
containsAny	string[]	Il valore del campo dell'evento verrà confrontato con i valori di questa matrice (senza distinzione tra maiuscole e minuscole) per determinare se la condizione viene soddisfatta.
equals	string	Il valore del campo dell'evento verrà confrontato con questo valore (senza distinzione tra maiuscole e minuscole) per determinare se la condizione viene soddisfatta.
field	string	Nome del campo dell'evento del log attività che questa condizione esaminerà. I valori possibili per questo campo sono (senza distinzione tra maiuscole e minuscole): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', o qualsiasi elemento che inizia con 'properties'.

AlertRulePatchObject

Oggetto regola di avviso del log attività per il corpo delle operazioni patch.

Nome	Tipo	Valore predefinito	Descrizione
properties.enabled	boolean	True	Indica se questa regola di avviso del log attività è abilitata. Se una regola di avviso del log attività non è abilitata, nessuna delle relative azioni verrà attivata.
tags	object		Tag delle risorse

ErrorResponse

Risposta di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.