Alert Processing Rules - Update

Referenz

Dienst:: Monitor

API-Version:: 2021-08-08

Aktivieren, Deaktivieren oder Aktualisieren von Tags für eine Warnungsverarbeitungsregel.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
alertProcessingRuleName	path	True	string	Der Name, der aktualisiert werden muss.
resourceGroupName	path	True	string	Ressourcengruppenname, in dem die Ressource erstellt wird.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	api-version	Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
properties.enabled	boolean	Gibt an, ob die angegebene Warnungsverarbeitungsregel aktiviert oder deaktiviert ist.
tags	object	Tags, die aktualisiert werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	AlertProcessingRule	OKAY. Gibt die Regel zur Erstellung/Aktualisierung der Warnungsverarbeitung zurück. Header x-ms-request-id: string
Other Status Codes	errorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

AlertProcessingRule

OKAY. Gibt die Regel zur Erstellung/Aktualisierung der Warnungsverarbeitung zurück.

Header

x-ms-request-id: string

Other Status Codes

errorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

PatchAlertProcessingRule

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AddActionGroups	Fügen Sie Aktionsgruppen zur Warnungsverarbeitungsregel hinzu.
AlertProcessingRule	Warnungsverarbeitungsregelobjekt, das Zielbereiche, Bedingungen und Planungslogik enthält.
AlertProcessingRuleProperties	Eigenschaften der Warnungsverarbeitungsregel, die Bereiche, Bedingungen und Planungslogik für warnungsverarbeitungsregel definieren.
api-version	Client-API-Version.
Condition	Bedingung zum Auslösen einer Warnungsverarbeitungsregel.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DailyRecurrence	Tägliches Serienobjekt.
DaysOfWeek	Wochentage.
errorResponse	Eine Fehlerantwort des Diensts.
errorResponseBody	Details zur Fehlerantwort.
Field	Feld für eine bestimmte Bedingung.
MonthlyRecurrence	Monatliches Serienobjekt.
Operator	Operator für eine bestimmte Bedingung.
PatchObject	Datenvertrag für Patch.
RemoveAllActionGroups	Gibt an, ob alle Aktionsgruppen entfernt werden sollen.
Schedule	Planen der Konfiguration für eine bestimmte Warnungsverarbeitungsregel.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
WeeklyRecurrence	Wöchentliches Serienobjekt.

AddActionGroups

Objekt

Fügen Sie Aktionsgruppen zur Warnungsverarbeitungsregel hinzu.

Name	Typ	Beschreibung
actionGroupIds	string[]	Liste der Aktionsgruppen-IDs, die der Warnungsverarbeitungsregel hinzugefügt werden sollen.
actionType	string: AddActionGroups	Aktion, die angewendet werden soll.

AlertProcessingRule

Objekt

Warnungsverarbeitungsregelobjekt, das Zielbereiche, Bedingungen und Planungslogik enthält.

Name	Typ	Beschreibung
id	string	Azure-Ressourcen-ID
location	string	Ressourcenspeicherort
name	string	Name der Azure-Ressource
properties	AlertProcessingRuleProperties	Eigenschaften der Warnungsverarbeitungsregel.
systemData	systemData	Warnungsverarbeitungsregelsystemdaten.
tags	object	Ressourcentags
type	string	Azure-Ressourcentyp

AlertProcessingRuleProperties

Objekt

Eigenschaften der Warnungsverarbeitungsregel, die Bereiche, Bedingungen und Planungslogik für warnungsverarbeitungsregel definieren.

Name	Typ	Standardwert	Beschreibung
actions	Action[]: AddActionGroups[] RemoveAllActionGroups[]		Aktionen, die angewendet werden sollen.
conditions	Condition[]		Bedingungen, nach denen Warnungen gefiltert werden.
description	string		Beschreibung der Warnungsverarbeitungsregel.
enabled	boolean	True	Gibt an, ob die angegebene Warnungsverarbeitungsregel aktiviert oder deaktiviert ist.
schedule	Schedule		Planen der Regel für die Benachrichtigungsverarbeitung.
scopes	string[]		Bereiche, auf die die Warnungsverarbeitungsregel angewendet wird.

api-version

Enumeration

Client-API-Version.

Wert	Beschreibung
2021-08-08

Condition

Objekt

Bedingung zum Auslösen einer Warnungsverarbeitungsregel.

Name	Typ	Beschreibung
field	Field	Feld für eine bestimmte Bedingung.
operator	Operator	Operator für eine bestimmte Bedingung.
values	string[]	Liste der Werte, die für eine bestimmte Bedingung übereinstimmen sollen.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DailyRecurrence

Objekt

Tägliches Serienobjekt.

Name	Typ	Beschreibung
endTime	string	Endzeit für Serie.
recurrenceType	string: Daily	Gibt an, wann die Serie angewendet werden soll.
startTime	string	Startzeit für Serie.

DaysOfWeek

Enumeration

Wochentage.

Wert	Beschreibung
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

errorResponse

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	errorResponseBody	Details zur Fehlerantwort.

errorResponseBody

Objekt

Details zur Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode, der programmgesteuert verwendet werden soll.
details	errorResponseBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Beschreibung des Fehlers, der für die Anzeige auf der Benutzeroberfläche vorgesehen ist.
target	string	Ziel des bestimmten Fehlers, z. B. Name der Eigenschaft.

Field

Enumeration

Feld für eine bestimmte Bedingung.

Wert	Beschreibung
AlertContext
AlertRuleId
AlertRuleName
Description
MonitorCondition
MonitorService
Severity
SignalType
TargetResource
TargetResourceGroup
TargetResourceType

MonthlyRecurrence

Objekt

Monatliches Serienobjekt.

Name	Typ	Beschreibung
daysOfMonth	integer[] (int32)	Gibt die Werte für das monatliche Serienmuster an.
endTime	string	Endzeit für Serie.
recurrenceType	string: Monthly	Gibt an, wann die Serie angewendet werden soll.
startTime	string	Startzeit für Serie.

Operator

Enumeration

Operator für eine bestimmte Bedingung.

Wert	Beschreibung
Contains
DoesNotContain
Equals
NotEquals

PatchObject

Objekt

Datenvertrag für Patch.

Name	Typ	Beschreibung
properties.enabled	boolean	Gibt an, ob die angegebene Warnungsverarbeitungsregel aktiviert oder deaktiviert ist.
tags	object	Tags, die aktualisiert werden sollen.

RemoveAllActionGroups

Objekt

Gibt an, ob alle Aktionsgruppen entfernt werden sollen.

Name	Typ	Beschreibung
actionType	string: RemoveAllActionGroups	Aktion, die angewendet werden soll.

Schedule

Objekt

Planen der Konfiguration für eine bestimmte Warnungsverarbeitungsregel.

Name	Typ	Beschreibung
effectiveFrom	string pattern: ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$	Terminplanung ab der Zeit. Date-Time im ISO-8601-Format ohne Zeitzonensuffix.
effectiveUntil	string pattern: ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$	Terminplanung bis zur Zeit. Date-Time im ISO-8601-Format ohne Zeitzonensuffix.
recurrences	Recurrence[]: DailyRecurrence[] MonthlyRecurrence[] WeeklyRecurrence[]	Liste der Serien.
timeZone	string	Zeitzone wird geplant.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

WeeklyRecurrence

Objekt

Wöchentliches Serienobjekt.

Name	Typ	Beschreibung
daysOfWeek	DaysOfWeek[]	Gibt die Werte für das wöchentliche Serienmuster an.
endTime	string	Endzeit für Serie.
recurrenceType	string: Weekly	Gibt an, wann die Serie angewendet werden soll.
startTime	string	Startzeit für Serie.

Freigeben über

Alert Processing Rules - Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

PatchAlertProcessingRule

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AddActionGroups

AlertProcessingRule

AlertProcessingRuleProperties

api-version

Condition

createdByType

DailyRecurrence

DaysOfWeek

errorResponse

errorResponseBody

Field

MonthlyRecurrence

Operator

PatchObject

RemoveAllActionGroups

Schedule

systemData

WeeklyRecurrence