Alerts - Get All

Referenz

Dienst:: Monitor

API-Version:: 2023-07-12-preview

Listen Sie alle vorhandenen Warnungen auf, bei denen die Ergebnisse anhand mehrerer Parameter (z. B. Zeitbereich) gefiltert werden können. Die Ergebnisse können dann nach den spezifischen Feldern sortiert werden, wobei der Standardwert lastModifiedDateTime ist.

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts?api-version=2023-07-12-preview

Mit optionalen Parametern:

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts?targetResource={targetResource}&targetResourceType={targetResourceType}&targetResourceGroup={targetResourceGroup}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&alertState={alertState}&alertRule={alertRule}&smartGroupId={smartGroupId}&includeContext={includeContext}&includeEgressConfig={includeEgressConfig}&pageCount={pageCount}&sortBy={sortBy}&sortOrder={sortOrder}&select={select}&timeRange={timeRange}&customTimeRange={customTimeRange}&api-version=2023-07-12-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
scope	path	True	string	Der Bereich hier ist resourceId, für den eine Warnung erstellt wird.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
alertRule	query		string	Filtern Sie nach einer bestimmten Warnungsregel. Der Standardwert besteht darin, alle auszuwählen.
alertState	query		AlertState	Filtern Sie nach dem Status der warnungs instance. Der Standardwert besteht darin, alle auszuwählen.
customTimeRange	query		string	Filtern Sie nach benutzerdefiniertem Zeitbereich im Format / in dem die Zeit ist (ISO-8601-Format)". Zulässige Werte sind innerhalb von 30 Tagen ab Abfragezeit. Entweder timeRange oder customTimeRange kann verwendet werden, aber nicht beides. Standardwert ist „none“.
includeContext	query		boolean	Schließen Sie Kontext ein, der kontextspezifische Daten für den Monitordienst enthält. Der Standardwert ist false.
includeEgressConfig	query		boolean	Schließen Sie ausgehende Konfiguration ein, die zum Anzeigen des Inhalts im Portal verwendet wird. Der Standardwert ist "false".
monitorCondition	query		MonitorCondition	Filtern Sie nach Überwachungsbedingung, die entweder "Ausgelöst" oder "Aufgelöst" lautet. Der Standardwert besteht darin, alle auszuwählen.
monitorService	query		MonitorService	Filtern Sie nach dem Monitordienst, der die Warnung instance generiert. Der Standardwert ist "Alle auswählen".
pageCount	query		integer int64	Bestimmt die Anzahl der pro Seite zurückgegebenen Warnungen als Antwort. Der zulässige Wert liegt zwischen 1 und 250. Wenn der Filter "includeContent" ausgewählt ist, ist der maximal zulässige Wert 25. Der Standardwert ist 25.
select	query		string	Dieser Filter ermöglicht die Auswahl der Felder (durch Kommas getrennt), die Teil des wesentlichen Abschnitts sein würden. Dies würde es ermöglichen, nur die erforderlichen Felder zu projizieren, anstatt den gesamten Inhalt zu erhalten. Standardmäßig werden alle Felder im Abschnitt essentials abgerufen.
severity	query		Severity	Filtern Sie nach Schweregrad. Der Standardwert ist "Alle auswählen".
smartGroupId	query		string	Filtern Sie die Warnungsliste nach der Smart Group ID. Der Standardwert ist keine.
sortBy	query		AlertsSortByFields	Sortieren Sie die Abfrageergebnisse nach dem Eingabefeld. Standardwert ist "lastModifiedDateTime".
sortOrder	query		SortOrder	Sortieren Sie die Reihenfolge der Abfrageergebnisse entweder aufsteigend oder absteigend. Der Standardwert ist "desc" für Zeitfelder und "asc" für andere Felder.
targetResource	query		string	Filtern nach Zielressource( die vollständige ARM-ID) Standardwert ist alle auswählen.
targetResourceGroup	query		string	Filtern Sie nach Dem Namen der Zielressourcengruppe. Der Standardwert ist "Alle auswählen".
targetResourceType	query		string	Filtern Sie nach Zielressourcentyp. Der Standardwert ist "Alle auswählen".
timeRange	query		TimeRange	Filtern Sie nach Zeitbereich nach den unten aufgeführten Werten. Der Standardwert ist 1 Tag.

Antworten

Name	Typ	Beschreibung
200 OK	alertsList	OK. Warnungsobjekte wurden erfolgreich aufgelistet.
Other Status Codes	errorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

ListAlerts

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts?api-version=2023-07-12-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "nextLink": "https://management.azure.com:443/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts?api-version=2018-05-05-preview&timeRange=1d&ctoken=%2bRID%3aPlwOAPHEGwB9UwEAAAAgCw%3d%3d%23RT%3a2%23TRC%3a500%23RTD%3aqtQyMDE4LTA2LTEyVDE1OjEyOjE1",
  "value": [
    {
      "properties": {
        "essentials": {
          "severity": "Sev3",
          "signalType": "Log",
          "alertState": "Acknowledged",
          "monitorCondition": "Fired",
          "monitorService": "Application Insights",
          "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight",
          "targetResourceName": "servicedeskappinsight",
          "targetResourceGroup": "servicedeskresourcegroup",
          "targetResourceType": "components",
          "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
          "smartGroupId": "23d6b2ce-8c54-468f-aff0-sd32aebb7e56",
          "smartGroupingReason": "Occurred frequently with other alerts",
          "alertRule": "https://servisdffsdf.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
          "startDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedUserName": "System",
          "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
          "actionStatus": {
            "isSuppressed": false
          },
          "description": "description of the alert"
        },
        "egressConfig": {},
        "context": {}
      },
      "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
      "type": "Microsoft.AlertsManagement/alerts",
      "name": "cpu alert"
    },
    {
      "properties": {
        "essentials": {
          "severity": "Sev3",
          "signalType": "Log",
          "alertState": "New",
          "monitorCondition": "Fired",
          "monitorService": "Application Insights",
          "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/cind/providers/microsoft.operationalinsights/workspaces/servicedeskwcus",
          "targetResourceName": "servicedeskwcus",
          "targetResourceGroup": "servicedeskresourcegroup",
          "targetResourceType": "components",
          "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
          "smartGroupId": "d1c49c89-ea95-4697-a299-c0f5ebac62f1",
          "smartGroupingReason": "Alerts that frequently occur together have been grouped.",
          "alertRule": "https://servicsdfsdf.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
          "startDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedUserName": "System",
          "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
          "actionStatus": {
            "isSuppressed": false
          },
          "description": "description of the alert"
        },
        "egressConfig": {},
        "context": {}
      },
      "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
      "type": "Microsoft.AlertsManagement/alerts",
      "name": "cpu alert"
    }
  ]
}

Definitionen

Name	Beschreibung
actionStatus	Status einer Aktion
alert	Eine Warnung, die im Warnungsverwaltungsdienst erstellt wurde.
alertProperties	Warnungseigenschaftenbehälter
alertsList	Listen Sie die Warnungen auf.
AlertsSortByFields	Sortieren Sie die Abfrageergebnisse nach dem Eingabefeld. Standardwert ist "lastModifiedDateTime".
AlertState	Warnungsobjektstatus, der vom Benutzer geändert werden kann.
errorResponse	Eine Fehlerantwort vom Dienst.
errorResponseBody	Details zur Fehlerantwort.
essentials	Dieses Objekt enthält konsistente Felder für verschiedene Monitordienste.
MonitorCondition	Bedingung der Regel im Monitordienst. Sie stellt dar, ob die zugrunde liegenden Bedingungen die definierten Schwellenwerte für Warnungsregel überschritten haben.
MonitorService	Überwachen Sie den Dienst, für den die Regel(monitor) festgelegt ist.
Severity	Schweregrad der Warnung Sev0 ist am höchsten und Sev4 am niedrigsten.
SignalType	Der Typ des Signals, auf dem die Warnung basiert, wobei es sich um Metriken, Protokolle oder Aktivitätsprotokolle handeln kann.
SortOrder	Sortieren Sie die Reihenfolge der Abfrageergebnisse entweder aufsteigend oder absteigend. Der Standardwert ist "desc" für Zeitfelder und "asc" für andere Felder.
TimeRange	Filtern Sie nach Zeitbereich nach den unten aufgeführten Werten. Der Standardwert ist 1 Tag.

actionStatus

Status einer Aktion

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

alert

Eine Warnung, die im Warnungsverwaltungsdienst erstellt wurde.

Name	Typ	Beschreibung
id	string	Azure-Ressourcen-ID
name	string	Name der Azure-Ressource
properties	alertProperties	Warnungseigenschaftenbehälter
type	string	Azure-Ressourcentyp

alertProperties

Warnungseigenschaftenbehälter

Name	Typ	Beschreibung
context	object	Spezifische Informationen für den Monitordienst, die weitere kontextbezogene Details zur Warnung bereitstellen.
egressConfig	object	Konfiguration, die zum Anzeigen der Daten im Portal verwendet wird.
essentials	essentials	Dieses Objekt enthält konsistente Felder für verschiedene Monitordienste.

alertsList

Listen Sie die Warnungen auf.

Name	Typ	Beschreibung
nextLink	string	URL, um den nächsten Satz von Warnungen abzurufen.
value	alert[]	Liste der Warnungen

AlertsSortByFields

Sortieren Sie die Abfrageergebnisse nach dem Eingabefeld. Standardwert ist "lastModifiedDateTime".

Name	Typ	Beschreibung
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

AlertState

Warnungsobjektstatus, der vom Benutzer geändert werden kann.

Name	Typ	Beschreibung
Acknowledged	string
Closed	string
New	string

errorResponse

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	errorResponseBody	Details zur Fehlerantwort.

errorResponseBody

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 in der Benutzeroberfläche vorgesehen ist.
target	string	Ziel des bestimmten Fehlers, z. B. Name der Eigenschaft.

essentials

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

Name	Typ	Beschreibung
actionStatus	actionStatus	Status einer Aktion
alertRule	string	Rule(monitor), die eine Warnung instance ausgelöst hat. Je nach Monitordienst ist dies die ARM-ID oder der Name der Regel.
alertState	AlertState	Warnungsobjektstatus, der vom Benutzer geändert werden kann.
description	string	Warnungsbeschreibung.
lastModifiedDateTime	string	Letzte Änderungszeit (ISO-8601-Format) der Warnung instance.
lastModifiedUserName	string	Der Benutzer, der die Warnung zuletzt geändert hat, würde im Fall von Überwachungsdienstupdates der Benutzer "System" sein, andernfalls name des Benutzers.
monitorCondition	MonitorCondition	Bedingung der Regel im Monitordienst. Sie stellt dar, ob die zugrunde liegenden Bedingungen die definierten Schwellenwerte für Warnungsregel überschritten haben.
monitorConditionResolvedDateTime	string	Aufgelöste Zeit (ISO-8601-Format) der Warnung instance. Dies wird aktualisiert, wenn der Überwachungsdienst die Warnung instance lö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	Der Typ des Signals, auf dem die Warnung basiert, wobei es sich um Metriken, Protokolle oder Aktivitätsprotokolle handeln kann.
smartGroupId	string	Eindeutige ID der intelligenten Gruppe
smartGroupingReason	string	Ausführlicher Grund, der den Grund beschreibt, warum diese Warnung instance einer intelligenten Gruppe hinzugefügt wird
sourceCreatedId	string	Eindeutige ID, die vom Überwachungsdienst für jede Warnung instance erstellt wurde. Dies kann verwendet werden, um das Problem beim Monitordienst zu verfolgen, im Fall von Nagios, Zabbix, SCOM usw.
startDateTime	string	Erstellungszeit (ISO-8601-Format) der Warnung instance.
targetResource	string	ARM-Zielressource, für die warnung erstellt wurde.
targetResourceGroup	string	Ressourcengruppe der ARM-Zielressource, für die warnung erstellt wurde.
targetResourceName	string	Name des ZIEL-ARM-Ressourcennamens, für den die Warnung erstellt wurde.
targetResourceType	string	Ressourcentyp der ARM-Zielressource, für die warnung erstellt wurde.

MonitorCondition

Bedingung der Regel im Monitordienst. Sie stellt dar, ob die zugrunde liegenden Bedingungen die definierten Schwellenwerte für Warnungsregel überschritten haben.

Name	Typ	Beschreibung
Fired	string
Resolved	string

MonitorService

Überwachen Sie den Dienst, für den die Regel(monitor) festgelegt ist.

Name	Typ	Beschreibung
ActivityLog Administrative	string
ActivityLog Autoscale	string
ActivityLog Policy	string
ActivityLog Recommendation	string
ActivityLog Security	string
Application Insights	string
Log Analytics	string
Nagios	string
Platform	string
Resource Health	string
SCOM	string
ServiceHealth	string
SmartDetector	string
VM Insights	string
Zabbix	string

Severity

Schweregrad der Warnung Sev0 ist am höchsten und Sev4 am niedrigsten.

Name	Typ	Beschreibung
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SignalType

Der Typ des Signals, auf dem die Warnung basiert, wobei es sich um Metriken, Protokolle oder Aktivitätsprotokolle handeln kann.

Name	Typ	Beschreibung
Log	string
Metric	string
Unknown	string

SortOrder

Sortieren Sie die Reihenfolge der Abfrageergebnisse entweder aufsteigend oder absteigend. Der Standardwert ist "desc" für Zeitfelder und "asc" für andere Felder.

Name	Typ	Beschreibung
asc	string
desc	string

TimeRange

Filtern Sie nach Zeitbereich nach den unten aufgeführten Werten. Der Standardwert ist 1 Tag.

Name	Typ	Beschreibung
1d	string
1h	string
30d	string
7d	string

Freigeben über