Alerts - Get Summary

Referencia

Szolgáltatás:: Monitor

API-verzió:: 2023-07-12-preview

A riasztások összesített számát különböző paraméterek szerint csoportosítva kaphatja meg (például a "Súlyosság" szerinti csoportosítás az egyes súlyosságokhoz tartozó riasztások számát adja vissza).

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

Opcionális paraméterekkel:

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-paraméterek

Name	In	Kötelező	Típus	Description
scope	path	True	string	A hatókör itt resourceId, amelyhez a riasztás létrejön.
api-version	query	True	string	A művelethez használandó API-verzió.
groupby	query	True	AlertsSummaryGroupByFields	Ez a paraméter lehetővé teszi, hogy az eredményhalmazt bemeneti mezők szerint csoportosítsa (legfeljebb 2 vesszővel tagolt mező támogatott). Például: groupby=severity vagy groupby=severity,alertstate.
alertRule	query		string	Szűrés adott riasztási szabály alapján. Az alapértelmezett érték az összes kijelölése.
alertState	query		AlertState	Szűrjön a riasztáspéldány állapota szerint. Az alapértelmezett érték az összes kijelölése.
customTimeRange	query		string	Szűrjön egyéni időtartomány szerint a formátum vagy az idő helye szerint (ISO-8601 formátum)". A megengedett értékek a lekérdezési időtől számított 30 napon belül lesznek megadva. A timeRange vagy a customTimeRange használható, de mindkettő nem. Az alapértelmezett érték a none.
includeSmartGroupsCount	query		boolean	Adja meg a SmartGroups számát az összefoglalás részeként. Az alapértelmezett érték "false".
monitorCondition	query		MonitorCondition	Szűrjön monitorozási feltétel alapján, amely "Aktiválva" vagy "Feloldva". Az alapértelmezett érték az összes kijelölése.
monitorService	query		MonitorService	Szűrés monitorozási szolgáltatás alapján, amely létrehozza a riasztáspéldányt. Az alapértelmezett érték az összes kijelölése.
severity	query		Severity	Szűrés súlyosság szerint. Az alapértelmezett érték az összes kijelölése.
targetResource	query		string	Szűrés célerőforrás szerint (amely teljes ARM-azonosító) Az alapértelmezett érték az összes kijelölése.
targetResourceGroup	query		string	Szűrés célerőforráscsoport neve alapján. Az alapértelmezett érték az összes kijelölése.
targetResourceType	query		string	Szűrés célerőforrás-típus szerint. Az alapértelmezett érték az összes kijelölése.
timeRange	query		TimeRange	Szűrjön időtartomány szerint az alábbi felsorolt értékek szerint. Az alapértelmezett érték 1 nap.

Válaszok

Name	Típus	Description
200 OK	alertsSummary	OK gombra. A riasztás összegzése visszaadva.
Other Status Codes	errorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Példák

Summary

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
}

Definíciók

Name	Description
alertsSummary	Riasztások összegzése a bemeneti szűrők és a "groupby" paraméterek alapján.
alertsSummaryGroup	Csoportosítsa az eredményhalmazt.
AlertsSummaryGroupByFields	Ez a paraméter lehetővé teszi, hogy az eredményhalmazt bemeneti mezők szerint csoportosítsa (legfeljebb 2 vesszővel tagolt mező támogatott). Például: groupby=severity vagy groupby=severity,alertstate.
alertsSummaryGroupItem	Riasztások összefoglaló csoporteleme
AlertState	Riasztási objektum állapota, amelyet a felhasználó módosíthat.
errorResponse	Hibaválasz a szolgáltatástól.
errorResponseBody	A hibaválasz részletei.
MonitorCondition	A szabály állapota a figyelőszolgáltatásban. Azt jelzi, hogy a mögöttes feltételek átlépték-e a riasztási szabály meghatározott küszöbértékeit.
MonitorService	Monitorozási szolgáltatás, amelyen a szabály(monitor) be van állítva.
Severity	Az Sev0 riasztás súlyossága a legmagasabb, az Sev4 pedig a legalacsonyabb.
TimeRange	Szűrjön időtartomány szerint az alábbi felsorolt értékek szerint. Az alapértelmezett érték 1 nap.

alertsSummary

Riasztások összegzése a bemeneti szűrők és a "groupby" paraméterek alapján.

Name	Típus	Description
id	string	Azure-erőforrás azonosítója
name	string	Azure-erőforrás neve
properties	alertsSummaryGroup	Csoportosítsa az eredményhalmazt.
type	string	Azure-erőforrástípus

alertsSummaryGroup

Csoportosítsa az eredményhalmazt.

Name	Típus	Description
groupedby	string	Az összesített mező neve
smartGroupsCount	integer	Az intelligens csoportok teljes száma.
total	integer	Az eredményhalmaz teljes száma.
values	alertsSummaryGroupItem[]	Az elemek listája

AlertsSummaryGroupByFields

Ez a paraméter lehetővé teszi, hogy az eredményhalmazt bemeneti mezők szerint csoportosítsa (legfeljebb 2 vesszővel tagolt mező támogatott). Például: groupby=severity vagy groupby=severity,alertstate.

Name	Típus	Description
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

Riasztások összefoglaló csoporteleme

Name	Típus	Description
count	integer	Az összesített mező száma
groupedby	string	Az összesített mező neve
name	string	Az összesített mező értéke
values	alertsSummaryGroupItem[]	Az elemek listája

AlertState

Riasztási objektum állapota, amelyet a felhasználó módosíthat.

Name	Típus	Description
Acknowledged	string
Closed	string
New	string

errorResponse

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	errorResponseBody	A hibaválasz részletei.

errorResponseBody

A hibaválasz részletei.

Name	Típus	Description
code	string	Hibakód, amely programozott módon használható.
details	errorResponseBody[]	A hibával kapcsolatos további részletek listája.
message	string	A hiba leírása, amely a felhasználói felületen való megjelenítésre szolgál.
target	string	Az adott hiba célja, például a tulajdonság neve.

MonitorCondition

A szabály állapota a figyelőszolgáltatásban. Azt jelzi, hogy a mögöttes feltételek átlépték-e a riasztási szabály meghatározott küszöbértékeit.

Name	Típus	Description
Fired	string
Resolved	string

MonitorService

Monitorozási szolgáltatás, amelyen a szabály(monitor) be van állítva.

Name	Típus	Description
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

Az Sev0 riasztás súlyossága a legmagasabb, az Sev4 pedig a legalacsonyabb.

Name	Típus	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

Szűrjön időtartomány szerint az alábbi felsorolt értékek szerint. Az alapértelmezett érték 1 nap.

Name	Típus	Description
1d	string
1h	string
30d	string
7d	string

Megosztás a következőn keresztül: