Alerts - Get Summary

Referenz

Dienst:: Monitor

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

Erhalten Sie eine zusammengefasste Anzahl Ihrer Warnungen, die nach verschiedenen Parametern gruppiert sind (z. B. gruppieren 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

Mit optionalen Parametern:

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	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.
groupby	query	True	AlertsSummaryGroupByFields	Mit diesem Parameter kann das Resultset nach Eingabefeldern gruppiert werden (maximal 2 durch Trennzeichen getrennte Felder werden unterstützt). Beispiel: groupby=schweregrad oder groupby=schweregrad,alertstate.
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.
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 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".
severity	query		Severity	Filtern sie nach Schweregrad. Der Standardwert ist "Alle auswählen".
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	alertsSummary	OKAY. Die Warnungszusammenfassung wurde zurückgegeben.
Other Status Codes	errorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

Summary

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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	Gruppieren Sie das Resultset.
AlertsSummaryGroupByFields	Mit diesem Parameter kann das Resultset nach Eingabefeldern gruppiert werden (maximal 2 durch Trennzeichen getrennte Felder werden unterstützt). Beispiel: groupby=schweregrad oder groupby=schweregrad,alertstate.
alertsSummaryGroupItem	Zusammenfassungsgruppenelement "Warnungen"
AlertState	Warnungsobjektstatus, der vom Benutzer geändert werden kann.
errorResponse	Eine Fehlerantwort des Diensts.
errorResponseBody	Details zur Fehlerantwort.
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.
TimeRange	Filtert nach Zeitbereich nach unten aufgeführten Werten. Der Standardwert ist 1 Tag.

alertsSummary

Objekt

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	Gruppieren Sie das Resultset.
type	string	Azure-Ressourcentyp

alertsSummaryGroup

Objekt

Gruppieren Sie das Resultset.

Name	Typ	Beschreibung
groupedby	string	Name des aggregierten Felds
smartGroupsCount	integer (int64)	Die Gesamtanzahl der intelligenten Gruppen.
total	integer (int64)	Die Gesamtanzahl des Resultsets.
values	alertsSummaryGroupItem[]	Liste der Elemente

AlertsSummaryGroupByFields

Enumeration

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

Wert	Beschreibung
alertRule
alertState
monitorCondition
monitorService
severity
signalType

alertsSummaryGroupItem

Objekt

Zusammenfassungsgruppenelement "Warnungen"

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

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.

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

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 Summary

URI-Parameter

Antworten

Beispiele

Summary

Beispielanforderung

Beispiel für eine Antwort

Definitionen

alertsSummary

alertsSummaryGroup

AlertsSummaryGroupByFields

alertsSummaryGroupItem

AlertState

errorResponse

errorResponseBody

MonitorCondition

MonitorService

Severity

TimeRange

Zusätzliche Ressourcen