Alerts - Change State Tenant

Dienst:: Monitor

API-Version:: 2025-05-25-preview

Ändern des Status einer Warnung.

POST https://management.azure.com/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate?api-version=2025-05-25-preview&newState={newState}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
alertId	path	True	string	Eindeutige ID einer Warnungsinstanz.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
newState	query	True	AlertState	Neuer Status der Warnung.

Anforderungstext

Name	Typ	Beschreibung
comments	string

Antworten

Name	Typ	Beschreibung
200 OK	Alert	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	AlertsManagementErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Resolve

POST https://management.azure.com/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100/changestate?api-version=2025-05-25-preview&newState=Acknowledged

package armalertsmanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/alertsmanagement/armalertsmanagement"
)

// Generated from example definition: 2025-05-25-preview/Alerts_ChangeStateTenant.json
func ExampleAlertsClient_ChangeStateTenant() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armalertsmanagement.NewClientFactory("<scope>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAlertsClient().ChangeStateTenant(ctx, "66114d64-d9d9-478b-95c9-b789d6502100", armalertsmanagement.AlertStateAcknowledged, &armalertsmanagement.AlertsClientChangeStateTenantOptions{
		Comment: &armalertsmanagement.Comments{}})
	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 = armalertsmanagement.AlertsClientChangeStateTenantResponse{
	// 	Alert: &armalertsmanagement.Alert{
	// 		Name: to.Ptr("cpu alert"),
	// 		Type: to.Ptr("Microsoft.AlertsManagement/alerts"),
	// 		ID: to.Ptr("/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100"),
	// 		Properties: &armalertsmanagement.AlertProperties{
	// 			Context: map[string]any{
	// 			},
	// 			EgressConfig: map[string]any{
	// 			},
	// 			Essentials: &armalertsmanagement.Essentials{
	// 				Description: to.Ptr("description of the alert"),
	// 				ActionStatus: &armalertsmanagement.ActionStatus{
	// 					IsSuppressed: to.Ptr(false),
	// 				},
	// 				AlertRule: to.Ptr("https://servisdfsdfappinsight.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId="),
	// 				AlertState: to.Ptr(armalertsmanagement.AlertStateAcknowledged),
	// 				LastModifiedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-13T15:51:02Z"); return t}()),
	// 				LastModifiedUserName: to.Ptr("System"),
	// 				MonitorCondition: to.Ptr(armalertsmanagement.MonitorConditionFired),
	// 				MonitorConditionResolvedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-13T15:51:02Z"); return t}()),
	// 				MonitorService: to.Ptr(armalertsmanagement.MonitorServiceApplicationInsights),
	// 				Severity: to.Ptr(armalertsmanagement.SeveritySev3),
	// 				SignalType: to.Ptr(armalertsmanagement.SignalTypeLog),
	// 				SmartGroupID: to.Ptr("23d6b2ce-8c54-468f-aff0-sd32aebb7e56"),
	// 				SmartGroupingReason: to.Ptr("Occurred frequently with other alerts"),
	// 				SourceCreatedID: to.Ptr("6cd6b2ce-8c54-468f-aff0-9d12aebb7e49"),
	// 				StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-13T15:51:02Z"); return t}()),
	// 				TargetResource: to.Ptr("/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight"),
	// 				TargetResourceGroup: to.Ptr("servicedeskresourcegroup"),
	// 				TargetResourceName: to.Ptr("servicedeskappinsight"),
	// 				TargetResourceType: to.Ptr("components"),
	// 			},
	// 		},
	// 	},
	// }
}

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

{
  "name": "cpu alert",
  "type": "Microsoft.AlertsManagement/alerts",
  "id": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
  "properties": {
    "context": {},
    "egressConfig": {},
    "essentials": {
      "description": "description of the alert",
      "actionStatus": {
        "isSuppressed": false
      },
      "alertRule": "https://servisdfsdfappinsight.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
      "alertState": "Acknowledged",
      "lastModifiedDateTime": "2018-09-13T15:51:02Z",
      "lastModifiedUserName": "System",
      "monitorCondition": "Fired",
      "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
      "monitorService": "Application Insights",
      "severity": "Sev3",
      "signalType": "Log",
      "smartGroupId": "23d6b2ce-8c54-468f-aff0-sd32aebb7e56",
      "smartGroupingReason": "Occurred frequently with other alerts",
      "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
      "startDateTime": "2018-09-13T15:51:02Z",
      "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight",
      "targetResourceGroup": "servicedeskresourcegroup",
      "targetResourceName": "servicedeskappinsight",
      "targetResourceType": "components"
    }
  }
}

Definitionen

Name	Beschreibung
ActionStatus	Status der Aktion
Alert	Eine Warnung, die im Warnungsverwaltungsdienst erstellt wurde.
AlertProperties	Benachrichtigungs-Eigenschaftstasche
AlertsManagementErrorResponse	Eine Fehlerantwort vom Dienst.
AlertState
Comments	Ändern des Grundes für den Alarmstatus
ErrorResponseBody	Details zur Fehlerantwort.
Essentials	Dieses Objekt enthält konsistente Felder für verschiedene Monitordienste.
MonitorCondition
MonitorService
Severity
SignalType	Die Art des Signals, auf dem die Warnung basiert, z. B. Metriken, Protokolle oder Aktivitätsprotokolle.

ActionStatus

Objekt

Status der Aktion

Name	Typ	Beschreibung
isSuppressed	boolean	Wert, der angibt, ob der Alarm unterdrückt wird.

Alert

Objekt

Eine Warnung, die im Warnungsverwaltungsdienst erstellt wurde.

Name	Typ	Beschreibung
id	string	Azure-Ressourcen-ID
name	string	Name der Azure-Ressource
properties	AlertProperties	Benachrichtigungs-Eigenschaftstasche
type	string	Azure-Ressourcentyp

AlertProperties

Objekt

Benachrichtigungs-Eigenschaftstasche

Name	Typ	Beschreibung
context		Spezifische Informationen für den Überwachungsdienst, die kontextbezogene Details zur Warnung enthalten.
customProperties	object	Benutzerdefinierte Eigenschaften, die beliebige benutzerdefinierte Schlüssel-Wert-Paare enthalten können
egressConfig		Config, die für die Anzeige der Daten im Portal verwendet wird.
essentials	Essentials	Dieses Objekt enthält konsistente Felder für verschiedene Monitordienste.

AlertsManagementErrorResponse

Objekt

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	ErrorResponseBody	Details zur Fehlerantwort.

AlertState

Enumeration

Wert	Beschreibung
New	New
Acknowledged	Anerkannt
Closed	Geschlossen

Comments

Objekt

Ändern des Grundes für den Alarmstatus

Name	Typ	Beschreibung
comments	string

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 in der Benutzeroberfläche angezeigt werden soll.
target	string	Ziel des jeweiligen Fehlers, z. B. Name der Eigenschaft.

Essentials

Objekt

Dieses Objekt enthält konsistente Felder für verschiedene Monitordienste.

Name	Typ	Beschreibung
actionStatus	ActionStatus	Status der Aktion
alertRule	string	Regel (monitor), die die Alarminstanz ausgelöst hat. Je nach Überwachungsdienst ist dies die ARM-ID oder der Name der Regel.
alertState	AlertState	Status des Warnungsobjekts, der vom Benutzer geändert werden kann.
description	string	Warnungsbeschreibung.
lastModifiedDateTime	string (date-time)	Zeitpunkt der letzten Änderung (ISO-8601-Format) der Alarminstanz.
lastModifiedUserName	string	Der Benutzer, der die Warnung zuletzt geändert hat, im Falle von Aktualisierungen des Überwachungsdienstes ist der Benutzer "System", andernfalls der Name des Benutzers.
monitorCondition	MonitorCondition	Kann "Ausgelöst" oder "Gelöst" sein, was angibt, ob die zugrunde liegenden Bedingungen die definierten Schwellenwerte für die Alarmregel überschritten haben.
monitorConditionResolvedDateTime	string (date-time)	Die Zeit (ISO-8601-Format) der Warnungsinstanz wurde behoben. Diese wird aktualisiert, wenn der Überwachungsdienst die Warnungsinstanz auflöst, da die Regelbedingung nicht mehr erfüllt ist.
monitorService	MonitorService	Überwachen Sie den Dienst, für den die Regel (monitor) festgelegt ist.
severity	Severity	Schweregrad der Warnung Sev0 ist am höchsten und Sev4 am niedrigsten.
signalType	SignalType	Die Art des Signals, auf dem die Warnung basiert, z. B. Metriken, Protokolle oder Aktivitätsprotokolle.
smartGroupId	string	Eindeutige ID der Smartgroup
smartGroupingReason	string	Ausführlicher Grund, der den Grund beschreibt, warum diese Warnungsinstanz einer Smartgroup hinzugefügt wird
sourceCreatedId	string	Eindeutige ID, die vom Überwachungsdienst für jede Warnungsinstanz erstellt wird. Dies könnte verwendet werden, um das Problem beim Monitor-Dienst zu verfolgen, im Falle von Nagios, Zabbix, SCOM usw.
startDateTime	string (date-time)	Erstellungszeit (ISO-8601-Format) der Alarminstanz.
targetResource	string	Ziel-ARM-Ressource, für die eine Warnung erstellt wurde.
targetResourceGroup	string	Ressourcengruppe der ARM-Zielressource, für die eine Warnung erstellt wurde.
targetResourceName	string	Name des Namens der ARM-Zielressource, für die eine Warnung erstellt wurde.
targetResourceType	string	Ressourcentyp der ARM-Zielressource, für die eine Warnung erstellt wurde.

MonitorCondition

Enumeration

Wert	Beschreibung
Fired	Entlassen
Resolved	Gelöst

MonitorService

Enumeration

Wert	Beschreibung
Application Insights	Application Insights
ActivityLog Administrative	ActivityLog Administrativ
ActivityLog Security	ActivityLog-Sicherheit
ActivityLog Recommendation	ActivityLog-Empfehlung
ActivityLog Policy	ActivityLog-Richtlinie
ActivityLog Autoscale	ActivityLog Autoscale
Log Analytics	Log Analytics
Nagios	Nagios
Platform	Plattform
SCOM	SCOM
ServiceHealth	ServiceHealth
SmartDetector	SmartDetector
VM Insights	VM Insights
Zabbix	Zabbix
Resource Health	Resource Health

Severity

Enumeration

Wert	Beschreibung
Sev0	Sev0
Sev1	Sev1
Sev2	Sev2
Sev3	Sev3
Sev4	Sev4

SignalType

Enumeration

Die Art des Signals, auf dem die Warnung basiert, z. B. Metriken, Protokolle oder Aktivitätsprotokolle.

Wert	Beschreibung
Metric	Metric
Log	Log
Unknown	Unbekannt

Freigeben über

Alerts - Change State Tenant

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Resolve

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ActionStatus

Alert

AlertProperties

AlertsManagementErrorResponse

AlertState

Comments

ErrorResponseBody

Essentials

MonitorCondition

MonitorService

Severity

SignalType