Alerts - Get Summary

Reference

Service:: Monitor

API Version:: 2023-07-12-preview

Získejte souhrnný počet výstrah seskupených podle různých parametrů (například seskupení podle závažnosti vrátí počet výstrah pro každou závažnost).

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
scope	path	True	string	scope tady je resourceId, pro který se vytvoří výstraha.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
groupby	query	True	AlertsSummaryGroupByFields	Tento parametr umožňuje seskupit sadu výsledků podle vstupních polí (podporují se maximálně 2 pole oddělená čárkami). Například groupby=severity nebo groupby=severity,alertstate.
alertRule	query		string	Filtrovat podle konkrétního pravidla upozornění. Výchozí hodnota je vybrat vše.
alertState	query		AlertState	Filtrovat podle stavu instance výstrahy. Výchozí hodnota je vybrat vše.
customTimeRange	query		string	Filtrujte podle vlastního časového rozsahu ve formátu / kde je čas (formát ISO-8601). Přípustné hodnoty jsou do 30 dnů od doby dotazu. Bylo možné použít timeRange nebo customTimeRange, ale ne obojí. Výchozí hodnota je none.
includeSmartGroupsCount	query		boolean	Do souhrnu zahrňte počet skupin SmartGroup. Výchozí hodnota je false.
monitorCondition	query		MonitorCondition	Filtrujte podle podmínky monitorování, která je buď aktivovaná, nebo vyřešená. Výchozí hodnota je vybrat vše.
monitorService	query		MonitorService	Filtrovat podle služby monitorování, která vygeneruje instanci výstrahy. Výchozí hodnota je vybrat vše.
severity	query		Severity	Filtrovat podle závažnosti: Výchozí hodnota je vybrat vše.
targetResource	query		string	Filtrovat podle cílového prostředku( což je úplné ID ARM) Výchozí hodnota je vybrat vše.
targetResourceGroup	query		string	Filtrovat podle názvu cílové skupiny prostředků. Výchozí hodnota je vybrat vše.
targetResourceType	query		string	Filtrovat podle typu cílového prostředku. Výchozí hodnota je vybrat vše.
timeRange	query		TimeRange	Filtrovat podle časového rozsahu podle níže uvedených hodnot. Výchozí hodnota je 1 den.

Odpovědi

Name	Typ	Description
200 OK	alertsSummary	OK. Byl vrácen souhrn upozornění.
Other Status Codes	errorResponse	Chybová odpověď popisující, proč operace selhala.

Příklady

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"
}

Definice

Name	Description
alertsSummary	Souhrn upozornění na základě vstupních filtrů a parametrů groupby
alertsSummaryGroup	Seskupte sadu výsledků.
AlertsSummaryGroupByFields	Tento parametr umožňuje seskupit sadu výsledků podle vstupních polí (podporují se maximálně 2 pole oddělená čárkami). Například groupby=severity nebo groupby=severity,alertstate.
alertsSummaryGroupItem	Souhrnná položka skupiny upozornění
AlertState	Stav objektu výstrahy, který může uživatel upravit.
errorResponse	Chybová odpověď ze služby.
errorResponseBody	Podrobnosti o odpovědi na chybu
MonitorCondition	Podmínka pravidla ve službě monitorování. Představuje, jestli podkladové podmínky překročily definované prahové hodnoty pravidla upozornění.
MonitorService	Monitorování služby, na které je nastaveno pravidlo (monitorování).
Severity	Závažnost výstrahy Sev0 je nejvyšší a Sev4 nejnižší.
TimeRange	Filtrovat podle časového rozsahu podle níže uvedených hodnot. Výchozí hodnota je 1 den.

alertsSummary

Souhrn upozornění na základě vstupních filtrů a parametrů groupby

Name	Typ	Description
id	string	ID prostředku Azure
name	string	Název prostředku Azure
properties	alertsSummaryGroup	Seskupte sadu výsledků.
type	string	Typ prostředku Azure

alertsSummaryGroup

Seskupte sadu výsledků.

Name	Typ	Description
groupedby	string	Název agregovaného pole
smartGroupsCount	integer	Celkový počet inteligentních skupin
total	integer	Celkový počet sady výsledků.
values	alertsSummaryGroupItem[]	Seznam položek

AlertsSummaryGroupByFields

Tento parametr umožňuje seskupit sadu výsledků podle vstupních polí (podporují se maximálně 2 pole oddělená čárkami). Například groupby=severity nebo groupby=severity,alertstate.

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

alertsSummaryGroupItem

Souhrnná položka skupiny upozornění

Name	Typ	Description
count	integer	Počet agregovaného pole
groupedby	string	Název agregovaného pole
name	string	Hodnota agregovaného pole
values	alertsSummaryGroupItem[]	Seznam položek

AlertState

Stav objektu výstrahy, který může uživatel upravit.

Name	Typ	Description
Acknowledged	string
Closed	string
New	string

errorResponse

Chybová odpověď ze služby.

Name	Typ	Description
error	errorResponseBody	Podrobnosti o odpovědi na chybu

errorResponseBody

Podrobnosti o odpovědi na chybu

Name	Typ	Description
code	string	Kód chyby, který má být využíván programově.
details	errorResponseBody[]	Seznam dalších podrobností o chybě
message	string	Popis chyby, která je určená k zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby, například název vlastnosti.

MonitorCondition

Podmínka pravidla ve službě monitorování. Představuje, jestli podkladové podmínky překročily definované prahové hodnoty pravidla upozornění.

Name	Typ	Description
Fired	string
Resolved	string

MonitorService

Monitorování služby, na které je nastaveno pravidlo (monitorování).

Name	Typ	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

Závažnost výstrahy Sev0 je nejvyšší a Sev4 nejnižší.

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

TimeRange

Filtrovat podle časového rozsahu podle níže uvedených hodnot. Výchozí hodnota je 1 den.

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