Alert Processing Rules - Update

Referência

Serviço:: Monitor

Versão da API:: 2021-08-08

Habilitar, desabilitar ou atualizar marcas para uma regra de processamento de alerta.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}?api-version=2021-08-08

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
alertProcessingRuleName	path	True	string	O nome que precisa ser atualizado.
resourceGroupName	path	True	string	Nome do grupo de recursos em que o recurso é criado.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	api-version	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
properties.enabled	boolean	Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada.
tags	object	Marcas a serem atualizadas.

Respostas

Nome	Tipo	Description
200 OK	AlertProcessingRule	OKEY. Retorna a regra de processamento de alerta criada/atualizada. Cabeçalhos x-ms-request-id: string
Other Status Codes	errorResponse	Resposta de erro que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

AlertProcessingRule

OKEY. Retorna a regra de processamento de alerta criada/atualizada.

Cabeçalhos

x-ms-request-id: string

Other Status Codes

errorResponse

Resposta de erro que descreve por que a operação falhou.

Exemplos

PatchAlertProcessingRule

Solicitação de exemplo

PATCH https://management.azure.com/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/WeeklySuppression?api-version=2021-08-08

{
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "enabled": false
  }
}


import com.azure.resourcemanager.alertsmanagement.models.AlertProcessingRule;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for AlertProcessingRules Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-08-08/examples/
     * AlertProcessingRules_Patch.json
     */
    /**
     * Sample code: PatchAlertProcessingRule.
     * 
     * @param manager Entry point to AlertsManagementManager.
     */
    public static void
        patchAlertProcessingRule(com.azure.resourcemanager.alertsmanagement.AlertsManagementManager manager) {
        AlertProcessingRule resource
            = manager.alertProcessingRules().getByResourceGroupWithResponse("alertscorrelationrg", "WeeklySuppression",
                com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf("key1", "fakeTokenPlaceholder", "key2", "fakeTokenPlaceholder"))
            .withEnabled(false).apply();
    }

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.alertsmanagement import AlertsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-alertsmanagement
# USAGE
    python alert_processing_rules_patch.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AlertsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="1e3ff1c0-771a-4119-a03b-be82a51e232d",
    )

    response = client.alert_processing_rules.update(
        resource_group_name="alertscorrelationrg",
        alert_processing_rule_name="WeeklySuppression",
        alert_processing_rule_patch={"properties": {"enabled": False}, "tags": {"key1": "value1", "key2": "value2"}},
    )
    print(response)


# x-ms-original-file: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-08-08/examples/AlertProcessingRules_Patch.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armalertsmanagement_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/alertsmanagement/armalertsmanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/6d2438481021a94793b07b226df06d5f3c61d51d/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-08-08/examples/AlertProcessingRules_Patch.json
func ExampleAlertProcessingRulesClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armalertsmanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAlertProcessingRulesClient().Update(ctx, "alertscorrelationrg", "WeeklySuppression", armalertsmanagement.PatchObject{
		Properties: &armalertsmanagement.PatchProperties{
			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.AlertProcessingRule = armalertsmanagement.AlertProcessingRule{
	// 	Name: to.Ptr("WeeklySuppression"),
	// 	Type: to.Ptr("Microsoft.AlertsManagement/actionRules"),
	// 	ID: to.Ptr("/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/WeeklySuppression"),
	// 	Location: to.Ptr("Global"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armalertsmanagement.AlertProcessingRuleProperties{
	// 		Description: to.Ptr("Alert processing rule on resource group for weekly suppression"),
	// 		Actions: []armalertsmanagement.ActionClassification{
	// 			&armalertsmanagement.RemoveAllActionGroups{
	// 				ActionType: to.Ptr(armalertsmanagement.ActionTypeRemoveAllActionGroups),
	// 		}},
	// 		Conditions: []*armalertsmanagement.Condition{
	// 			{
	// 				Field: to.Ptr(armalertsmanagement.FieldSeverity),
	// 				Operator: to.Ptr(armalertsmanagement.OperatorEquals),
	// 				Values: []*string{
	// 					to.Ptr("Sev0"),
	// 					to.Ptr("Sev2")},
	// 				},
	// 				{
	// 					Field: to.Ptr(armalertsmanagement.FieldMonitorService),
	// 					Operator: to.Ptr(armalertsmanagement.OperatorEquals),
	// 					Values: []*string{
	// 						to.Ptr("Platform"),
	// 						to.Ptr("Application Insights")},
	// 					},
	// 					{
	// 						Field: to.Ptr(armalertsmanagement.FieldTargetResourceType),
	// 						Operator: to.Ptr(armalertsmanagement.OperatorNotEquals),
	// 						Values: []*string{
	// 							to.Ptr("Microsoft.Compute/VirtualMachines")},
	// 					}},
	// 					Enabled: to.Ptr(false),
	// 					Schedule: &armalertsmanagement.Schedule{
	// 						EffectiveFrom: to.Ptr("2018-12-10T22:05:09"),
	// 						EffectiveUntil: to.Ptr("2018-12-05T22:05:09"),
	// 						Recurrences: []armalertsmanagement.RecurrenceClassification{
	// 							&armalertsmanagement.WeeklyRecurrence{
	// 								EndTime: to.Ptr("14:00:00"),
	// 								RecurrenceType: to.Ptr(armalertsmanagement.RecurrenceTypeWeekly),
	// 								StartTime: to.Ptr("06:00:00"),
	// 								DaysOfWeek: []*armalertsmanagement.DaysOfWeek{
	// 									to.Ptr(armalertsmanagement.DaysOfWeekTuesday),
	// 									to.Ptr(armalertsmanagement.DaysOfWeekFriday)},
	// 							}},
	// 							TimeZone: to.Ptr("Pacific Standard Time"),
	// 						},
	// 						Scopes: []*string{
	// 							to.Ptr("/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg")},
	// 						},
	// 						SystemData: &armalertsmanagement.SystemData{
	// 							CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-12T22:05:09.000Z"); return t}()),
	// 							CreatedBy: to.Ptr("abc@microsoft.com"),
	// 							CreatedByType: to.Ptr(armalertsmanagement.CreatedByTypeUser),
	// 							LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-12T22:05:09.000Z"); return t}()),
	// 							LastModifiedBy: to.Ptr("xyz@microsoft.com"),
	// 							LastModifiedByType: to.Ptr(armalertsmanagement.CreatedByTypeUser),
	// 						},
	// 					}
}

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.AlertsManagement.Models;
using Azure.ResourceManager.AlertsManagement;

// Generated from example definition: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-08-08/examples/AlertProcessingRules_Patch.json
// this example is just showing the usage of "AlertProcessingRules_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 AlertProcessingRuleResource created on azure
// for more information of creating AlertProcessingRuleResource, please refer to the document of AlertProcessingRuleResource
string subscriptionId = "1e3ff1c0-771a-4119-a03b-be82a51e232d";
string resourceGroupName = "alertscorrelationrg";
string alertProcessingRuleName = "WeeklySuppression";
ResourceIdentifier alertProcessingRuleResourceId = AlertProcessingRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, alertProcessingRuleName);
AlertProcessingRuleResource alertProcessingRule = client.GetAlertProcessingRuleResource(alertProcessingRuleResourceId);

// invoke the operation
AlertProcessingRulePatch patch = new AlertProcessingRulePatch
{
    Tags =
    {
    ["key1"] = "value1",
    ["key2"] = "value2"
    },
    IsEnabled = false,
};
AlertProcessingRuleResource result = await alertProcessingRule.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
AlertProcessingRuleData 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 de exemplo

Código de status:: 200

{
  "systemData": {
    "createdBy": "abc@microsoft.com",
    "createdByType": "User",
    "createdAt": "2018-06-12T22:05:09Z",
    "lastModifiedBy": "xyz@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2018-06-12T22:05:09Z"
  },
  "properties": {
    "scopes": [
      "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg"
    ],
    "conditions": [
      {
        "field": "Severity",
        "operator": "Equals",
        "values": [
          "Sev0",
          "Sev2"
        ]
      },
      {
        "field": "MonitorService",
        "operator": "Equals",
        "values": [
          "Platform",
          "Application Insights"
        ]
      },
      {
        "field": "TargetResourceType",
        "operator": "NotEquals",
        "values": [
          "Microsoft.Compute/VirtualMachines"
        ]
      }
    ],
    "schedule": {
      "effectiveFrom": "2018-12-10T22:05:09",
      "effectiveUntil": "2018-12-05T22:05:09",
      "timeZone": "Pacific Standard Time",
      "recurrences": [
        {
          "recurrenceType": "Weekly",
          "startTime": "06:00:00",
          "endTime": "14:00:00",
          "daysOfWeek": [
            "Tuesday",
            "Friday"
          ]
        }
      ]
    },
    "actions": [
      {
        "actionType": "RemoveAllActionGroups"
      }
    ],
    "description": "Alert processing rule on resource group for weekly suppression",
    "enabled": false
  },
  "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/WeeklySuppression",
  "type": "Microsoft.AlertsManagement/actionRules",
  "name": "WeeklySuppression",
  "location": "Global",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  }
}

Definições

Nome	Description
AddActionGroups	Adicione grupos de ações à regra de processamento de alertas.
AlertProcessingRule	Objeto de regra de processamento de alerta que contém escopos de destino, condições e lógica de agendamento.
AlertProcessingRuleProperties	Propriedades da regra de processamento de alerta definindo escopos, condições e lógica de agendamento para a regra de processamento de alerta.
api-version	Versão da API do cliente.
Condition	Condição para disparar uma regra de processamento de alerta.
createdByType	O tipo de identidade que criou o recurso.
DailyRecurrence	Objeto de recorrência diária.
DaysOfWeek	Dias da semana.
errorResponse	Uma resposta de erro do serviço.
errorResponseBody	Detalhes da resposta de erro.
Field	Campo para uma determinada condição.
MonthlyRecurrence	Objeto de recorrência mensal.
Operator	Operador para uma determinada condição.
PatchObject	Contrato de dados para patch.
RemoveAllActionGroups	Indica se todos os grupos de ações devem ser removidos.
Schedule	Configuração de agendamento para uma determinada regra de processamento de alerta.
systemData	Metadados relativos à criação e última modificação do recurso.
WeeklyRecurrence	Objeto de recorrência semanal.

AddActionGroups

Objeto

Adicione grupos de ações à regra de processamento de alertas.

Nome	Tipo	Description
actionGroupIds	string[]	Lista de IDs do grupo de ações a serem adicionadas à regra de processamento de alerta.
actionType	string: AddActionGroups	Ação que deve ser aplicada.

AlertProcessingRule

Objeto

Objeto de regra de processamento de alerta que contém escopos de destino, condições e lógica de agendamento.

Nome	Tipo	Description
id	string	ID de recurso do Azure
location	string	Local do recurso
name	string	Nome do recurso do Azure
properties	AlertProcessingRuleProperties	Propriedades da regra de processamento de alerta.
systemData	systemData	Dados do sistema de regras de processamento de alerta.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso do Azure

AlertProcessingRuleProperties

Objeto

Propriedades da regra de processamento de alerta definindo escopos, condições e lógica de agendamento para a regra de processamento de alerta.

Nome	Tipo	Valor padrão	Description
actions	Action[]: AddActionGroups[] RemoveAllActionGroups[]		Ações a serem aplicadas.
conditions	Condition[]		Condições nas quais os alertas serão filtrados.
description	string		Descrição da regra de processamento de alerta.
enabled	boolean	True	Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada.
schedule	Schedule		Agendamento para a regra de processamento de alerta.
scopes	string[]		Escopos nos quais a regra de processamento de alerta será aplicada.

api-version

Enumeração

Versão da API do cliente.

Valor	Description
2021-08-08

Condition

Objeto

Condição para disparar uma regra de processamento de alerta.

Nome	Tipo	Description
field	Field	Campo para uma determinada condição.
operator	Operator	Operador para uma determinada condição.
values	string[]	Lista de valores a serem correspondentes a uma determinada condição.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DailyRecurrence

Objeto

Objeto de recorrência diária.

Nome	Tipo	Description
endTime	string	Hora de término para recorrência.
recurrenceType	string: Daily	Especifica quando a recorrência deve ser aplicada.
startTime	string	Hora de início da recorrência.

DaysOfWeek

Enumeração

Dias da semana.

Valor	Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

errorResponse

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	errorResponseBody	Detalhes da resposta de erro.

errorResponseBody

Objeto

Detalhes da resposta de erro.

Nome	Tipo	Description
code	string	Código de erro, destinado a ser consumido programaticamente.
details	errorResponseBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Descrição do erro, destinado à exibição na interface do usuário.
target	string	Destino do erro específico, por exemplo, o nome da propriedade.

Field

Enumeração

Campo para uma determinada condição.

Valor	Description
AlertContext
AlertRuleId
AlertRuleName
Description
MonitorCondition
MonitorService
Severity
SignalType
TargetResource
TargetResourceGroup
TargetResourceType

MonthlyRecurrence

Objeto

Objeto de recorrência mensal.

Nome	Tipo	Description
daysOfMonth	integer[] (int32)	Especifica os valores para o padrão de recorrência mensal.
endTime	string	Hora de término para recorrência.
recurrenceType	string: Monthly	Especifica quando a recorrência deve ser aplicada.
startTime	string	Hora de início da recorrência.

Operator

Enumeração

Operador para uma determinada condição.

Valor	Description
Contains
DoesNotContain
Equals
NotEquals

PatchObject

Objeto

Contrato de dados para patch.

Nome	Tipo	Description
properties.enabled	boolean	Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada.
tags	object	Marcas a serem atualizadas.

RemoveAllActionGroups

Objeto

Indica se todos os grupos de ações devem ser removidos.

Nome	Tipo	Description
actionType	string: RemoveAllActionGroups	Ação que deve ser aplicada.

Schedule

Objeto

Configuração de agendamento para uma determinada regra de processamento de alerta.

Nome	Tipo	Description
effectiveFrom	string pattern: ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$	Agendamento em vigor a partir do momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário.
effectiveUntil	string pattern: ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$	Agendamento em vigor até o momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário.
recurrences	Recurrence[]: DailyRecurrence[] MonthlyRecurrence[] WeeklyRecurrence[]	Lista de recorrências.
timeZone	string	Agendamento de fuso horário.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

WeeklyRecurrence

Objeto

Objeto de recorrência semanal.

Nome	Tipo	Description
daysOfWeek	DaysOfWeek[]	Especifica os valores para o padrão de recorrência semanal.
endTime	string	Hora de término para recorrência.
recurrenceType	string: Weekly	Especifica quando a recorrência deve ser aplicada.
startTime	string	Hora de início da recorrência.

Compartilhar via

Alert Processing Rules - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

PatchAlertProcessingRule

Solicitação de exemplo

Resposta de exemplo

Definições

AddActionGroups

AlertProcessingRule

AlertProcessingRuleProperties

api-version

Condition

createdByType

DailyRecurrence

DaysOfWeek

errorResponse

errorResponseBody

Field

MonthlyRecurrence

Operator

PatchObject

RemoveAllActionGroups

Schedule

systemData

WeeklyRecurrence