Activity Log Alerts - Update

Referência

Serviço:: Monitor

Versão da API:: 2020-10-01

Atualiza os campos 'tags' e 'enabled' em uma regra de Alerta existente. Esse método é usado para atualizar as marcas de regra de Alerta e para habilitar ou desabilitar a regra de Alerta. Para atualizar outros campos, use a operação CreateOrUpdate.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
activityLogAlertName	path	True	string	O nome da regra de Alerta do Registro de Atividades.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties.enabled	boolean	Indica se essa regra de Alerta de Registro de Atividades está habilitada. Se uma regra de Alerta de Registro de Atividades não estiver habilitada, nenhuma de suas ações será ativada.
tags	object	As tags de recurso

Respostas

Name	Tipo	Description
200 OK	ActivityLogAlertResource	Uma regra de Alerta de Registro de Atividades existente foi atualizada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Patch an Activity Log Alert rule

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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."
  }
}

Definições

Name	Description
ActionGroup	Um ponteiro para um Grupo de Ação do Azure.
ActionList	Uma lista de ações da regra de Alerta do Registro de Atividades.
ActivityLogAlertResource	Um recurso de regra de Alerta de Log de Atividades.
AlertRuleAllOfCondition	Uma condição de regra de Alerta de Registro de Atividades que é atendida quando todas as condições de membro são atendidas.
AlertRuleAnyOfOrLeafCondition	Uma condição de regra de Alerta de Registro de Atividades que é atendida quando todas as condições de membro são atendidas. Cada condição pode ser de um dos seguintes tipos: Importante: Cada tipo tem seu subconjunto exclusivo de propriedades. Propriedades de diferentes tipos NÃO podem existir em uma condição. Condição da folha - deve conter 'campo' e 'igual' ou 'contémQualquer'. Por favor, note que 'anyOf' não deve* ser definido em uma condição de folha.* Condição AnyOf - deve conter apenas 'anyOf' (que é uma matriz de Condições Foliares). Por favor, note que 'campo', 'igual' e 'contémQualquer' não devem* ser definidos em uma condição AnyOf.*
AlertRuleLeafCondition	Uma condição de regra de Alerta do Log de Atividades que é atendida comparando o campo e o valor de um evento do Registro de Atividades. Esta condição deve conter «campo» e «igual» ou «contémQualquer».
AlertRulePatchObject	Um objeto de regra de Alerta de Registro de Atividades para o corpo de operações de patch.
ErrorResponse	A resposta de erro.

ActionGroup

Object

Um ponteiro para um Grupo de Ação do Azure.

Name	Tipo	Description
actionGroupId	string	A ID do recurso do Grupo de Ação. Isso não pode ser nulo ou vazio.
webhookProperties	object	O dicionário de propriedades personalizadas a serem incluídas na operação POST. Esses dados são anexados à carga útil do webhook.

ActionList

Object

Uma lista de ações da regra de Alerta do Registro de Atividades.

Name	Tipo	Description
actionGroups	ActionGroup[]	A lista dos Grupos de Ação.

ActivityLogAlertResource

Object

Um recurso de regra de Alerta de Log de Atividades.

Name	Tipo	Default value	Description
id	string		A ID do recurso.
location	string	global	A localização do recurso. As regras de Alerta do Registo de Atividades do Azure são suportadas nas regiões Global, Europa Ocidental e Europa do Norte.
name	string		O nome do recurso.
properties.actions	ActionList		As ações que serão ativadas quando a condição for atendida.
properties.condition	AlertRuleAllOfCondition		A condição que fará com que esse alerta seja ativado.
properties.description	string		Uma descrição desta regra de Alerta do Registo de Atividades.
properties.enabled	boolean	True	Indica se essa regra de Alerta de Registro de Atividades está habilitada. Se uma regra de Alerta de Registro de Atividades não estiver habilitada, nenhuma de suas ações será ativada.
properties.scopes	string[]		Uma lista de IDs de recursos que serão usados como prefixos. O alerta só se aplicará a eventos do Log de Atividades com IDs de recursos que se enquadrem em um desses prefixos. Esta lista deve incluir pelo menos um elemento.
tags	object		As tags do recurso.
type	string		O tipo do recurso.

AlertRuleAllOfCondition

Object

Uma condição de regra de Alerta de Registro de Atividades que é atendida quando todas as condições de membro são atendidas.

Name	Tipo	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	A lista de condições da regra de Alerta do Log de Atividades.

AlertRuleAnyOfOrLeafCondition

Object

Uma condição de regra de Alerta de Registro de Atividades que é atendida quando todas as condições de membro são atendidas. Cada condição pode ser de um dos seguintes tipos: Importante: Cada tipo tem seu subconjunto exclusivo de propriedades. Propriedades de diferentes tipos NÃO podem existir em uma condição.

Condição da folha - deve conter 'campo' e 'igual' ou 'contémQualquer'. Por favor, note que 'anyOf' não deve ser definido em uma condição de folha.
Condição AnyOf - deve conter apenas 'anyOf' (que é uma matriz de Condições Foliares). Por favor, note que 'campo', 'igual' e 'contémQualquer' não devem ser definidos em uma condição AnyOf.

Name	Tipo	Description
anyOf	AlertRuleLeafCondition[]	Uma condição 'anyOf' da regra de Alerta do Registro de Atividades. Uma condição de regra de Alerta de Registro de Atividades que é atendida quando pelo menos uma de suas condições de folha de membro é atendida.
containsAny	string[]	O valor do campo do evento será comparado com os valores nessa matriz (sem distinção entre maiúsculas e minúsculas) para determinar se a condição é atendida.
equals	string	O valor do campo do evento será comparado a esse valor (sem distinção entre maiúsculas e minúsculas) para determinar se a condição é atendida.
field	string	O nome do campo do evento Log de Atividades que essa condição examinará. Os valores possíveis para este campo são (sem distinção entre maiúsculas e minúsculas): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' ou qualquer coisa que comece com 'properties'.

AlertRuleLeafCondition

Object

Uma condição de regra de Alerta do Log de Atividades que é atendida comparando o campo e o valor de um evento do Registro de Atividades. Esta condição deve conter «campo» e «igual» ou «contémQualquer».

Name	Tipo	Description
containsAny	string[]	O valor do campo do evento será comparado com os valores nessa matriz (sem distinção entre maiúsculas e minúsculas) para determinar se a condição é atendida.
equals	string	O valor do campo do evento será comparado a esse valor (sem distinção entre maiúsculas e minúsculas) para determinar se a condição é atendida.
field	string	O nome do campo do evento Log de Atividades que essa condição examinará. Os valores possíveis para este campo são (sem distinção entre maiúsculas e minúsculas): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' ou qualquer coisa que comece com 'properties'.

AlertRulePatchObject

Object

Um objeto de regra de Alerta de Registro de Atividades para o corpo de operações de patch.

Name	Tipo	Default value	Description
properties.enabled	boolean	True	Indica se essa regra de Alerta de Registro de Atividades está habilitada. Se uma regra de Alerta de Registro de Atividades não estiver habilitada, nenhuma de suas ações será ativada.
tags	object		As tags de recurso

ErrorResponse

Object

A resposta de erro.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro que indica por que a operação falhou.

Partilhar via

Activity Log Alerts - Update

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Patch an Activity Log Alert rule

Pedido de amostra

Resposta da amostra

Definições

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

AlertRulePatchObject

ErrorResponse

Recursos adicionais