Alert Processing Rules - Update

Service:

Monitor

API Version:

2021-08-08

Abilitare, disabilitare o aggiornare i tag per una regola di elaborazione degli avvisi.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
alertProcessingRuleName	path	True	string	Nome che deve essere aggiornato.
resourceGroupName	path	True	string	Nome del gruppo di risorse in cui viene creata la risorsa.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	api-version	Versione API client.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.enabled	boolean	Indica se la regola di elaborazione degli avvisi specificata è abilitata o disabilitata.
tags	object	Tag da aggiornare.

Risposte

Nome	Tipo	Descrizione
200 OK	AlertProcessingRule	OK. Restituisce la regola di elaborazione degli avvisi creata/aggiornata. Headers x-ms-request-id: string
Other Status Codes	errorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

PatchAlertProcessingRule

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;
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", Context.NONE)
                .getValue();
        resource.update().withTags(mapOf("key1", "value1", "key2", "value2")).withEnabled(false).apply();
    }

    @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

Python

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

Go

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.AlertsManagement;
using Azure.ResourceManager.AlertsManagement.Models;
using Azure.ResourceManager.Resources;

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

Sample Response

Status code:

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

Definizioni

Nome	Descrizione
AddActionGroups	Aggiungere gruppi di azioni alla regola di elaborazione degli avvisi.
AlertProcessingRule	Oggetto regola di elaborazione degli avvisi contenente ambiti, condizioni e logica di pianificazione di destinazione.
AlertProcessingRuleProperties	Proprietà delle regole di elaborazione degli avvisi che definiscono ambiti, condizioni e logica di pianificazione per la regola di elaborazione degli avvisi.
api-version	Versione API client.
Condition	Condizione per attivare una regola di elaborazione degli avvisi.
createdByType	Tipo di identità che ha creato la risorsa.
DailyRecurrence	Oggetto ricorrenza giornaliera.
DaysOfWeek	Giorni della settimana.
errorResponse	Risposta di errore dal servizio.
errorResponseBody	Dettagli della risposta all'errore.
Field	Campo per una determinata condizione.
MonthlyRecurrence	Oggetto ricorrenza mensile.
Operator	Operatore per una determinata condizione.
PatchObject	Contratto dati per patch.
RemoveAllActionGroups	Indica se tutti i gruppi di azioni devono essere rimossi.
Schedule	Pianificazione della configurazione per una determinata regola di elaborazione degli avvisi.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
WeeklyRecurrence	Oggetto ricorrenza settimanale.

AddActionGroups

Aggiungere gruppi di azioni alla regola di elaborazione degli avvisi.

Nome	Tipo	Descrizione
actionGroupIds	string[]	Elenco di ID del gruppo di azioni da aggiungere alla regola di elaborazione degli avvisi.
actionType	string: AddActionGroups	Azione da applicare.

AlertProcessingRule

Oggetto regola di elaborazione degli avvisi contenente ambiti, condizioni e logica di pianificazione di destinazione.

Nome	Tipo	Descrizione
id	string	ID risorsa di Azure
location	string	Posizione risorsa
name	string	Nome risorsa di Azure
properties	AlertProcessingRuleProperties	Proprietà delle regole di elaborazione degli avvisi.
systemData	systemData	Dati del sistema delle regole di elaborazione degli avvisi.
tags	object	Tag delle risorse
type	string	Tipo di risorsa di Azure

AlertProcessingRuleProperties

Proprietà delle regole di elaborazione degli avvisi che definiscono ambiti, condizioni e logica di pianificazione per la regola di elaborazione degli avvisi.

Nome	Tipo	Valore predefinito	Descrizione
actions	Action[]: AddActionGroups[] RemoveAllActionGroups[]		Azioni da applicare.
conditions	Condition[]		Condizioni in base alle quali verranno filtrati gli avvisi.
description	string		Descrizione della regola di elaborazione degli avvisi.
enabled	boolean	True	Indica se la regola di elaborazione degli avvisi specificata è abilitata o disabilitata.
schedule	Schedule		Pianificazione per la regola di elaborazione degli avvisi.
scopes	string[]		Ambiti in cui verrà applicata la regola di elaborazione degli avvisi.

api-version

Versione API client.

Nome	Tipo	Descrizione
2021-08-08	string

Condition

Condizione per attivare una regola di elaborazione degli avvisi.

Nome	Tipo	Descrizione
field	Field	Campo per una determinata condizione.
operator	Operator	Operatore per una determinata condizione.
values	string[]	Elenco di valori da trovare per una determinata condizione.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

DailyRecurrence

Oggetto ricorrenza giornaliera.

Nome	Tipo	Descrizione
endTime	string	Ora di fine per la ricorrenza.
recurrenceType	string: Daily	Specifica quando deve essere applicata la ricorrenza.
startTime	string	Ora di inizio per la ricorrenza.

DaysOfWeek

Giorni della settimana.

Nome	Tipo	Descrizione
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

errorResponse

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	errorResponseBody	Dettagli della risposta all'errore.

errorResponseBody

Dettagli della risposta all'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore, destinato a essere utilizzato a livello di codice.
details	errorResponseBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Descrizione dell'errore, destinato alla visualizzazione nell'interfaccia utente.
target	string	Destinazione dell'errore specifico, ad esempio nome della proprietà.

Field

Campo per una determinata condizione.

Nome	Tipo	Descrizione
AlertContext	string
AlertRuleId	string
AlertRuleName	string
Description	string
MonitorCondition	string
MonitorService	string
Severity	string
SignalType	string
TargetResource	string
TargetResourceGroup	string
TargetResourceType	string

MonthlyRecurrence

Oggetto ricorrenza mensile.

Nome	Tipo	Descrizione
daysOfMonth	integer[]	Specifica i valori per il criterio di ricorrenza mensile.
endTime	string	Ora di fine per la ricorrenza.
recurrenceType	string: Monthly	Specifica quando deve essere applicata la ricorrenza.
startTime	string	Ora di inizio per la ricorrenza.

Operator

Operatore per una determinata condizione.

Nome	Tipo	Descrizione
Contains	string
DoesNotContain	string
Equals	string
NotEquals	string

PatchObject

Contratto dati per patch.

Nome	Tipo	Descrizione
properties.enabled	boolean	Indica se la regola di elaborazione degli avvisi specificata è abilitata o disabilitata.
tags	object	Tag da aggiornare.

RemoveAllActionGroups

Indica se tutti i gruppi di azioni devono essere rimossi.

Nome	Tipo	Descrizione
actionType	string: RemoveAllActionGroups	Azione da applicare.

Schedule

Pianificazione della configurazione per una determinata regola di elaborazione degli avvisi.

Nome	Tipo	Descrizione
effectiveFrom	string	Pianificazione effettiva in base al tempo. Date-Time in formato ISO-8601 senza suffisso fuso orario.
effectiveUntil	string	Pianificazione effettiva fino al momento. Date-Time in formato ISO-8601 senza suffisso fuso orario.
recurrences	Recurrence[]: DailyRecurrence[] MonthlyRecurrence[] WeeklyRecurrence[]	Elenco di ricorrenze.
timeZone	string	Pianificazione del fuso orario.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

WeeklyRecurrence

Oggetto ricorrenza settimanale.

Nome	Tipo	Descrizione
daysOfWeek	DaysOfWeek[]	Specifica i valori per il criterio di ricorrenza settimanale.
endTime	string	Ora di fine per la ricorrenza.
recurrenceType	string: Weekly	Specifica quando deve essere applicata la ricorrenza.
startTime	string	Ora di inizio per la ricorrenza.