Alerts - Get All

Referenz

Dienst:: Monitor

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

Alle vorhandenen Warnungen auflisten, in denen die Ergebnisse anhand mehrerer Parameter gefiltert werden können (z. B. Zeitbereich). Die Ergebnisse können dann anhand bestimmter Felder 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	hier ist resourceId, für die eine Warnung erstellt wird.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
alertRule	query		string	Filtern sie nach einer bestimmten Warnungsregel. Der Standardwert besteht darin, alle auszuwählen.
alertState	query		AlertState	Filtern nach Status der Warnungsinstanz. Der Standardwert besteht darin, alle auszuwählen.
customTimeRange	query		string	Filtern Sie nach benutzerdefiniertem Zeitbereich im Format/ in dem sich die Uhrzeit befindet (ISO-8601-Format)'. Zulässige Werte sind innerhalb von 30 Tagen nach der Abfragezeit. Entweder timeRange oder customTimeRange kann verwendet werden, aber nicht beides. Der Standardwert ist keine.
includeContext	query		boolean	Einschließen von Kontextdaten, die für den Monitordienst spezifisch sind. Standardwert ist "false"
includeEgressConfig	query		boolean	Schließen Sie die Ausgangskonfiguration ein, die zum Anzeigen des Inhalts im Portal verwendet wird. Der Standardwert ist "false".
monitorCondition	query		MonitorCondition	Filtern Sie nach Monitorbedingung, die entweder "Ausgelöst" oder "Aufgelöst" ist. Der Standardwert besteht darin, alle auszuwählen.
monitorService	query		MonitorService	Filtern Nach Überwachungsdienst, der die Warnungsinstanz 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(kommagetrennt), 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 Eingabefeld, Standardwert lautet "lastModifiedDateTime".
sortOrder	query		SortOrder	Sortieren Sie die Reihenfolge der Abfrageergebnisse in aufsteigender oder absteigender Reihenfolge. Der Standardwert ist 'desc' für Zeitfelder und 'asc' für andere.
targetResource	query		string	Filter nach Zielressource( die vollständige ARM-ID) Standardwert ist alle ausgewählt.
targetResourceGroup	query		string	Filtern nach Dem Namen der Zielressourcengruppe. Der Standardwert ist "Alle auswählen".
targetResourceType	query		string	Filtern nach Zielressourcentyp. Der Standardwert ist "Alle auswählen".
timeRange	query		TimeRange	Filtert nach Zeitbereich nach unten aufgeführten Werten. Der Standardwert ist 1 Tag.

Antworten

Name	Typ	Beschreibung
200 OK	alertsList	OKAY. Warnungsobjekte wurden erfolgreich aufgelistet.
Other Status Codes	errorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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	Benachrichtigungseigenschaftenbehälter
alertsList	Listen Sie die Warnungen auf.
AlertsSortByFields	Sortieren Sie die Abfrageergebnisse nach Eingabefeld, Standardwert lautet "lastModifiedDateTime".
AlertState	Warnungsobjektstatus, der vom Benutzer geändert werden kann.
errorResponse	Eine Fehlerantwort des Diensts.
errorResponseBody	Details zur Fehlerantwort.
essentials	Dieses Objekt enthält einheitliche Felder für unterschiedliche Monitordienste.
MonitorCondition	Bedingung der Regel am Monitordienst. Es stellt dar, ob die zugrunde liegenden Bedingungen die definierten Schwellenwerte für Warnungsregel überschritten haben.
MonitorService	Überwachen Sie den Dienst, auf dem 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, auf der Metriken, Protokolle oder Aktivitätsprotokolle sein können.
SortOrder	Sortieren Sie die Reihenfolge der Abfrageergebnisse in aufsteigender oder absteigender Reihenfolge. Der Standardwert ist 'desc' für Zeitfelder und 'asc' für andere.
TimeRange	Filtert nach Zeitbereich nach unten aufgeführten Werten. Der Standardwert ist 1 Tag.

actionStatus

Objekt

Status einer Aktion

Name	Typ	Beschreibung
isSuppressed	boolean	Wert, der angibt, ob die Warnung 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	Benachrichtigungseigenschaftenbehälter
type	string	Azure-Ressourcentyp

alertProperties

Objekt

Benachrichtigungseigenschaftenbehälter

Name	Typ	Beschreibung
context	object	Spezifische Informationen für den Monitordienst, der kontextbezogenere Details zu der Warnung bereitstellt.
egressConfig	object	Konfiguration, die zum Anzeigen der Daten im Portal verwendet wird.
essentials	essentials	Dieses Objekt enthält einheitliche Felder für unterschiedliche Monitordienste.

alertsList

Objekt

Listen Sie die Warnungen auf.

Name	Typ	Beschreibung
nextLink	string	URL zum Abrufen des nächsten Satzes von Warnungen.
value	alert[]	Liste der Warnungen

AlertsSortByFields

Enumeration

Sortieren Sie die Abfrageergebnisse nach Eingabefeld, Standardwert lautet "lastModifiedDateTime".

Wert	Beschreibung
alertState
lastModifiedDateTime
monitorCondition
name
severity
startDateTime
targetResource
targetResourceGroup
targetResourceName
targetResourceType

AlertState

Enumeration

Warnungsobjektstatus, der vom Benutzer geändert werden kann.

Wert	Beschreibung
Acknowledged
Closed
New

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.

essentials

Objekt

Dieses Objekt enthält einheitliche Felder für unterschiedliche Monitordienste.

Name	Typ	Beschreibung
actionStatus	actionStatus	Status einer Aktion
alertRule	string	Rule(monitor) which fired alert instance. Je nach Monitordienst wäre dies ARM-ID oder der Name der Regel.
alertState	AlertState	Warnungsobjektstatus, der vom Benutzer geändert werden kann.
description	string	Warnungsbeschreibung.
lastModifiedDateTime	string (date-time)	Zeitpunkt der letzten Änderung (ISO-8601-Format) der Warnungsinstanz.
lastModifiedUserName	string	Der Benutzer, der die Benachrichtigung zuletzt geändert hat, wäre bei der Überwachung von Dienstupdates der Benutzer "System", andernfalls der Name des Benutzers.
monitorCondition	MonitorCondition	Bedingung der Regel am Monitordienst. Es stellt dar, ob die zugrunde liegenden Bedingungen die definierten Schwellenwerte für Warnungsregel überschritten haben.
monitorConditionResolvedDateTime	string (date-time)	Aufgelöste Zeit (ISO-8601-Format) der Warnungsinstanz. Dies wird aktualisiert, wenn der Monitordienst die Warnungsinstanz aufgelöst, da die Regelbedingung nicht mehr erfüllt ist.
monitorService	MonitorService	Überwachen Sie den Dienst, auf dem 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, auf der Metriken, Protokolle oder Aktivitätsprotokolle sein können.
smartGroupId	string	Eindeutige ID der intelligenten Gruppe
smartGroupingReason	string	Ausführlicher Grund, der den Grund beschreibt, warum diese Warnungsinstanz einer intelligenten Gruppe hinzugefügt wird
sourceCreatedId	string	Eindeutige ID, die vom Monitordienst für jede Warnungsinstanz erstellt wurde. Dies könnte verwendet werden, um das Problem beim Monitordienst zu verfolgen, im Falle von Nghi, Zabbix, SCOM usw.
startDateTime	string (date-time)	Erstellungszeit (ISO-8601-Format) der Warnungsinstanz.
targetResource	string	Ziel-ARM-Ressource, für die warnung erstellt wurde.
targetResourceGroup	string	Ressourcengruppe der Ziel-ARM-Ressource, für die eine Warnung erstellt wurde.
targetResourceName	string	Name des Ziel-ARM-Ressourcennamens, für den die Warnung erstellt wurde.
targetResourceType	string	Ressourcentyp der ZIEL-ARM-Ressource, für die warnung erstellt wurde.

MonitorCondition

Enumeration

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

Wert	Beschreibung
Fired
Resolved

MonitorService

Enumeration

Überwachen Sie den Dienst, auf dem die Regel(monitor) festgelegt ist.

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

Severity

Enumeration

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

Wert	Beschreibung
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Enumeration

Der Typ des Signals, auf dem die Warnung basiert, auf der Metriken, Protokolle oder Aktivitätsprotokolle sein können.

Wert	Beschreibung
Log
Metric
Unknown

SortOrder

Enumeration

Sortieren Sie die Reihenfolge der Abfrageergebnisse in aufsteigender oder absteigender Reihenfolge. Der Standardwert ist 'desc' für Zeitfelder und 'asc' für andere.

Wert	Beschreibung
asc
desc

TimeRange

Enumeration

Filtert nach Zeitbereich nach unten aufgeführten Werten. Der Standardwert ist 1 Tag.

Wert	Beschreibung
1d
1h
30d
7d

Freigeben über

Alerts - Get All

URI-Parameter

Antworten

Beispiele

ListAlerts

Beispielanforderung

Beispiel für eine Antwort

Definitionen

actionStatus

alert

alertProperties

alertsList

AlertsSortByFields

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

SortOrder

TimeRange

Zusätzliche Ressourcen