Activity Log Alerts - Update

Servicio:

Monitor

Versión de la API:

2020-10-01

Novedades campos "tags" y "enabled" en una regla de alerta existente. Este método se usa para actualizar las etiquetas de regla de alerta y para habilitar o deshabilitar la regla de alertas. Para actualizar otros campos, use la operación CreateOrUpdate.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
activityLogAlertName	path	True	string	Nombre de la regla de alertas del registro de actividad.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.enabled	boolean	Indica si esta regla de alertas del registro de actividad está habilitada. Si una regla de alerta del registro de actividad no está habilitada, no se activará ninguna de sus acciones.
tags	object	Etiquetas de recursos

Respuestas

Nombre	Tipo	Description
200 OK	ActivityLogAlertResource	Se actualizó correctamente una regla de alerta del registro de actividad existente.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Patch an Activity Log Alert rule

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
ActionGroup	Puntero a un grupo de acciones de Azure.
ActionList	Una lista de acciones de regla de alertas del registro de actividad.
ActivityLogAlertResource	Un recurso de regla de alertas del registro de actividad.
AlertRuleAllOfCondition	Una condición de regla de alerta del registro de actividad que se cumple cuando se cumplen todas sus condiciones de miembro.
AlertRuleAnyOfOrLeafCondition	Una condición de regla de alerta del registro de actividad que se cumple cuando se cumplen todas sus condiciones de miembro. Cada condición puede ser de uno de los siguientes tipos: Importante: Cada tipo tiene su subconjunto único de propiedades. Las propiedades de diferentes tipos NO PUEDEN existir en una condición. Condición hoja: debe contener 'field' y 'equals' o 'containsAny'. Tenga en cuenta que 'anyOf' no debe establecerse en una condición hoja. AnyOf Condition:solo debe contener "anyOf" (que es una matriz de condiciones hoja). Tenga en cuenta que 'field', 'equals' y 'containsAny' no deben establecerse en una condición AnyOf.
AlertRuleLeafCondition	Una condición de regla de alerta del registro de actividad que se cumple comparando el campo y el valor de un evento del registro de actividad. Esta condición debe contener 'field' y 'equals' o 'containsAny'.
AlertRulePatchObject	Objeto de regla de alerta del registro de actividad para el cuerpo de las operaciones de revisión.
ErrorResponse	Respuesta de error.

ActionGroup

Puntero a un grupo de acciones de Azure.

Nombre	Tipo	Description
actionGroupId	string	Identificador de recurso del grupo de acciones. Esto no puede ser nulo ni estar vacío.
webhookProperties	object	diccionario de propiedades personalizadas que se van a incluir con la operación posterior. Estos datos se anexan a la carga del webhook.

ActionList

Una lista de acciones de regla de alertas del registro de actividad.

Nombre	Tipo	Description
actionGroups	ActionGroup[]	Lista de los grupos de acciones.

ActivityLogAlertResource

Un recurso de regla de alertas del registro de actividad.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador del recurso.
location	string	global	Ubicación del recurso. Las reglas de alertas del registro de actividad de Azure se admiten en las regiones Global, Oeste de Europa y Norte de Europa.
name	string		Nombre del recurso.
properties.actions	ActionList		Las acciones que se activarán cuando se cumpla la condición.
properties.condition	AlertRuleAllOfCondition		Condición que hará que esta alerta se active.
properties.description	string		Descripción de esta regla de alertas del registro de actividad.
properties.enabled	boolean	True	Indica si esta regla de alertas del registro de actividad está habilitada. Si una regla de alerta del registro de actividad no está habilitada, no se activará ninguna de sus acciones.
properties.scopes	string[]		Lista de identificadores de recursos que se usarán como prefijos. La alerta solo se aplicará a los eventos del registro de actividad con identificadores de recursos que se encuentran en uno de estos prefijos. Esta lista debe incluir al menos un elemento.
tags	object		Las etiquetas del recurso.
type	string		Tipo de recurso.

AlertRuleAllOfCondition

Una condición de regla de alerta del registro de actividad que se cumple cuando se cumplen todas sus condiciones de miembro.

Nombre	Tipo	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	Lista de condiciones de la regla de alertas del registro de actividad.

AlertRuleAnyOfOrLeafCondition

Una condición de regla de alerta del registro de actividad que se cumple cuando se cumplen todas sus condiciones de miembro. Cada condición puede ser de uno de los siguientes tipos: Importante: Cada tipo tiene su subconjunto único de propiedades. Las propiedades de diferentes tipos NO PUEDEN existir en una condición.

• Condición hoja: debe contener 'field' y 'equals' o 'containsAny'. Tenga en cuenta que 'anyOf' no debe establecerse en una condición hoja.
• AnyOf Condition:solo debe contener "anyOf" (que es una matriz de condiciones hoja). Tenga en cuenta que 'field', 'equals' y 'containsAny' no deben establecerse en una condición AnyOf.

Nombre	Tipo	Description
anyOf	AlertRuleLeafCondition[]	Una condición "anyOf" de la regla de alerta del registro de actividad. Una condición de regla de alerta del registro de actividad que se cumple cuando se cumple al menos una de sus condiciones de hoja miembro.
containsAny	string[]	El valor del campo del evento se comparará con los valores de esta matriz (sin distinción entre mayúsculas y minúsculas) para determinar si se cumple la condición.
equals	string	El valor del campo del evento se comparará con este valor (sin distinción entre mayúsculas y minúsculas) para determinar si se cumple la condición.
field	string	Nombre del campo del evento registro de actividad que examinará esta condición. Los valores posibles para este campo son (sin distinción entre mayúsculas y minúsculas): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', o cualquier elemento que comience por 'properties'.

AlertRuleLeafCondition

Una condición de regla de alerta del registro de actividad que se cumple comparando el campo y el valor de un evento del registro de actividad. Esta condición debe contener 'field' y 'equals' o 'containsAny'.

Nombre	Tipo	Description
containsAny	string[]	El valor del campo del evento se comparará con los valores de esta matriz (sin distinción entre mayúsculas y minúsculas) para determinar si se cumple la condición.
equals	string	El valor del campo del evento se comparará con este valor (sin distinción entre mayúsculas y minúsculas) para determinar si se cumple la condición.
field	string	Nombre del campo del evento registro de actividad que examinará esta condición. Los valores posibles para este campo son (sin distinción entre mayúsculas y minúsculas): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', o cualquier elemento que comience por 'properties'.

AlertRulePatchObject

Objeto de regla de alerta del registro de actividad para el cuerpo de las operaciones de revisión.

Nombre	Tipo	Valor predeterminado	Description
properties.enabled	boolean	True	Indica si esta regla de alertas del registro de actividad está habilitada. Si una regla de alerta del registro de actividad no está habilitada, no se activará ninguna de sus acciones.
tags	object		Etiquetas de recursos

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.