Alerts - Get Summary

Referenz

Service:: Monitor

API Version:: 2023-07-12-preview

Rufen Sie eine zusammengefasste Anzahl Ihrer Warnungen ab, die nach verschiedenen Parametern gruppiert sind (z. B. die Gruppierung nach "Schweregrad" gibt die Anzahl der Warnungen für jeden Schweregrad zurück).

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

With optional parameters:

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alertsSummary?groupby={groupby}&includeSmartGroupsCount={includeSmartGroupsCount}&targetResource={targetResource}&targetResourceType={targetResourceType}&targetResourceGroup={targetResourceGroup}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&alertState={alertState}&alertRule={alertRule}&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.
groupby	query	True	AlertsSummaryGroupByFields	Mit diesem Parameter kann das Resultset nach Eingabefeldern gruppiert werden (maximal 2 durch Kommas getrennte Felder werden unterstützt). Beispiel: groupby=severity oder groupby=severity,alertstate.
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“.
includeSmartGroupsCount	query		boolean	Schließen Sie die Anzahl der SmartGroups als Teil der Zusammenfassung ein. 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".
severity	query		Severity	Filtern Sie nach Schweregrad. Der Standardwert ist "Alle auswählen".
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	alertsSummary	OK. Die Warnungszusammenfassung wurde zurückgegeben.
Other Status Codes	errorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

Summary

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "properties": {
    "groupedby": "severity",
    "smartGroupsCount": 100,
    "total": 14189,
    "values": [
      {
        "name": "Sev0",
        "count": 6517,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 6517
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev1",
        "count": 3175,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 3175
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev2",
        "count": 1120,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1120
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev3",
        "count": 1902,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1902
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev4",
        "count": 1475,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1475
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary/current",
  "type": "Microsoft.AlertsManagement/alertsSummary",
  "name": "current"
}

Definitionen

Name	Beschreibung
alertsSummary	Zusammenfassung der Warnungen basierend auf den Eingabefiltern und den Parametern "groupby".
alertsSummaryGroup	Gruppierung des Resultsets.
AlertsSummaryGroupByFields	Mit diesem Parameter kann das Resultset nach Eingabefeldern gruppiert werden (maximal 2 durch Kommas getrennte Felder werden unterstützt). Beispiel: groupby=severity oder groupby=severity,alertstate.
alertsSummaryGroupItem	Gruppenelement "Warnungszusammenfassung"
AlertState	Warnungsobjektstatus, der vom Benutzer geändert werden kann.
errorResponse	Eine Fehlerantwort vom Dienst.
errorResponseBody	Details zur Fehlerantwort.
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.
TimeRange	Filtern Sie nach Zeitbereich nach den unten aufgeführten Werten. Der Standardwert ist 1 Tag.

alertsSummary

Zusammenfassung der Warnungen basierend auf den Eingabefiltern und den Parametern "groupby".

Name	Typ	Beschreibung
id	string	Azure-Ressourcen-ID
name	string	Name der Azure-Ressource
properties	alertsSummaryGroup	Gruppierung des Resultsets.
type	string	Azure-Ressourcentyp

alertsSummaryGroup

Gruppierung des Resultsets.

Name	Typ	Beschreibung
groupedby	string	Name des felds aggregiert
smartGroupsCount	integer	Gesamtanzahl der intelligenten Gruppen.
total	integer	Gesamtanzahl des Resultsets.
values	alertsSummaryGroupItem[]	Liste der Elemente

AlertsSummaryGroupByFields

Mit diesem Parameter kann das Resultset nach Eingabefeldern gruppiert werden (maximal 2 durch Kommas getrennte Felder werden unterstützt). Beispiel: groupby=severity oder groupby=severity,alertstate.

Name	Typ	Beschreibung
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

Gruppenelement "Warnungszusammenfassung"

Name	Typ	Beschreibung
count	integer	Anzahl des aggregierten Felds
groupedby	string	Name des felds aggregiert
name	string	Wert des aggregierten Felds
values	alertsSummaryGroupItem[]	Liste der Elemente

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.

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

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