Alerts - Get All

Reference

Service:: Monitor

API Version:: 2023-07-12-preview

Zobrazí seznam všech existujících výstrah, kde se výsledky dají filtrovat na základě více parametrů (např. časový rozsah). Výsledky se pak dají seřadit podle konkrétních polí, přičemž výchozí hodnota je lastModifiedDateTime.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
scope	path	True	string	obor je resourceId, pro který se vytvoří upozornění.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
alertRule	query		string	Filtrujte 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 / ve kterém je čas (formát ISO-8601). Přípustné hodnoty jsou do 30 dnů od doby dotazu. Bylo možné použít buď timeRange, nebo customTimeRange, ale ne obojí. Výchozí hodnota je none.
includeContext	query		boolean	Zahrnout kontext, který obsahuje kontextová data specifická pro službu monitorování. Výchozí hodnota je false.
includeEgressConfig	query		boolean	Zahrňte konfiguraci výchozího přenosu dat, která by se použila k zobrazení obsahu na portálu. 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	Filtrujte podle služby monitorování, která generuje instanci výstrahy. Výchozí hodnota je vybrat vše.
pageCount	query		integer int64	Určuje počet upozornění vrácených na stránku v odpovědi. Přípustná hodnota je mezi 1 a 250. Při výběru filtru includeContent je maximální povolená hodnota 25. Výchozí hodnota je 25.
select	query		string	Tento filtr umožňuje vybrat pole (oddělená čárkami), která by byla součástí základní části. To by umožnilo promítnout pouze požadovaná pole místo získání celého obsahu. Ve výchozím nastavení se načítají všechna pole v části Základy.
severity	query		Severity	Filtrovat podle závažnosti: Výchozí hodnota je vybrat vše.
smartGroupId	query		string	Vyfiltrujte seznam upozornění podle ID inteligentní skupiny. Výchozí hodnota je žádná.
sortBy	query		AlertsSortByFields	Seřaďte výsledky dotazu podle vstupního pole. Výchozí hodnota je lastModifiedDateTime.
sortOrder	query		SortOrder	Seřaďte výsledky dotazu vzestupně nebo sestupně. Výchozí hodnota je "desc" pro časová pole a "asc" pro ostatní.
targetResource	query		string	Filtrovat podle cílového prostředku( což je úplné ID ARM) Výchozí hodnota je select all (vybrat vše).
targetResourceGroup	query		string	Filtrujte podle názvu cílové skupiny prostředků. Výchozí hodnota je vybrat vše.
targetResourceType	query		string	Filtrujte podle typu cílového prostředku. Výchozí hodnota je vybrat vše.
timeRange	query		TimeRange	Filtrujte podle časového rozsahu podle níže uvedených hodnot. Výchozí hodnota je 1 den.

Odpovědi

Name	Typ	Description
200 OK	alertsList	OK. Objekty výstrah se úspěšně zobrazily.
Other Status Codes	errorResponse	Chybová odpověď popisující, proč operace selhala.

Příklady

ListAlerts

Sample Request

HTTP

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

Sample Response

Status code:: 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"
    }
  ]
}

Definice

Name	Description
actionStatus	Stav akce
alert	Výstraha vytvořená ve službě správy upozornění.
alertProperties	Kontejner vlastností upozornění
alertsList	Vypište výstrahy.
AlertsSortByFields	Seřaďte výsledky dotazu podle vstupního pole. Výchozí hodnota je lastModifiedDateTime.
AlertState	Stav objektu výstrahy, který může uživatel změnit.
errorResponse	Chybová odpověď ze služby.
errorResponseBody	Podrobnosti o chybové odpovědi.
essentials	Tento objekt obsahuje konzistentní pole napříč různými službami monitorování.
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, pro kterou je nastaveno pravidlo (monitor).
Severity	Závažnost výstrahy Sev0 je nejvyšší a závažnost 4 je nejnižší.
SignalType	Typ signálu, na kterém je upozornění založené, což můžou být metriky, protokoly nebo protokoly aktivit.
SortOrder	Seřaďte výsledky dotazu vzestupně nebo sestupně. Výchozí hodnota je "desc" pro časová pole a "asc" pro ostatní.
TimeRange	Filtrujte podle časového rozsahu podle níže uvedených hodnot. Výchozí hodnota je 1 den.

actionStatus

Stav akce

Name	Typ	Description
isSuppressed	boolean	Hodnota označující, jestli je upozornění potlačeno.

alert

Výstraha vytvořená ve službě správy upozornění.

Name	Typ	Description
id	string	ID prostředku Azure
name	string	Název prostředku Azure
properties	alertProperties	Kontejner vlastností upozornění
type	string	Typ prostředku Azure

alertProperties

Kontejner vlastností upozornění

Name	Typ	Description
context	object	Informace specifické pro službu monitorování, které poskytují další kontextové podrobnosti o výstraze.
egressConfig	object	Konfigurace, která by se použila k zobrazení dat na portálu.
essentials	essentials	Tento objekt obsahuje konzistentní pole napříč různými službami monitorování.

alertsList

Vypište výstrahy.

Name	Typ	Description
nextLink	string	Adresa URL pro načtení další sady upozornění
value	alert[]	Seznam výstrah

AlertsSortByFields

Seřaďte výsledky dotazu podle vstupního pole. Výchozí hodnota je lastModifiedDateTime.

Name	Typ	Description
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

AlertState

Stav objektu výstrahy, který může uživatel změnit.

Name	Typ	Description
Acknowledged	string
Closed	string
New	string

errorResponse

Chybová odpověď ze služby.

Name	Typ	Description
error	errorResponseBody	Podrobnosti o chybové odpovědi.

errorResponseBody

Podrobnosti o chybové odpovědi.

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.

essentials

Tento objekt obsahuje konzistentní pole napříč různými službami monitorování.

Name	Typ	Description
actionStatus	actionStatus	Stav akce
alertRule	string	Rule(monitor), který aktivoval instanci upozornění. V závislosti na službě monitorování to bude ID ARM nebo název pravidla.
alertState	AlertState	Stav objektu výstrahy, který může uživatel změnit.
description	string	Popis upozornění.
lastModifiedDateTime	string	Čas poslední změny (formát ISO-8601) instance výstrahy.
lastModifiedUserName	string	Uživatel, který výstrahu naposledy změnil, by v případě aktualizací služby monitorování byl uživatelem "system", jinak by se uživatel jmenoval "system".
monitorCondition	MonitorCondition	Podmínka pravidla ve službě monitorování. Představuje, jestli podkladové podmínky překročily definované prahové hodnoty pravidla upozornění.
monitorConditionResolvedDateTime	string	Vyřešený čas (formát ISO-8601) instance upozornění. Tato aktualizace se aktualizuje, když služba monitorování vyřeší instanci upozornění, protože už není splněná podmínka pravidla.
monitorService	MonitorService	Monitorování služby, pro kterou je nastaveno pravidlo (monitor).
severity	Severity	Závažnost výstrahy Sev0 je nejvyšší a závažnost 4 je nejnižší.
signalType	SignalType	Typ signálu, na kterém je upozornění založené, což můžou být metriky, protokoly nebo protokoly aktivit.
smartGroupId	string	Jedinečné ID inteligentní skupiny
smartGroupingReason	string	Podrobný důvod popisující důvod přidání této instance upozornění do inteligentní skupiny
sourceCreatedId	string	Jedinečné ID vytvořené službou monitorování pro každou instanci upozornění To může být použito ke sledování problému v monitorovací službě, v případě Nagios, Zabbix, SCOM atd.
startDateTime	string	Čas vytvoření instance upozornění (formát ISO-8601).
targetResource	string	Cílový prostředek ARM, pro který se vytvořilo upozornění.
targetResourceGroup	string	Skupina prostředků cílového prostředku ARM, pro který se vytvořilo upozornění.
targetResourceName	string	Název cílového prostředku ARM, na kterém se upozornění vytvořilo.
targetResourceType	string	Typ prostředku cílového prostředku ARM, pro který se vytvořilo upozornění.

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, pro kterou je nastaveno pravidlo (monitor).

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 závažnost 4 je nejnižší.

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

SignalType

Typ signálu, na kterém je upozornění založené, což můžou být metriky, protokoly nebo protokoly aktivit.

Name	Typ	Description
Log	string
Metric	string
Unknown	string

SortOrder

Seřaďte výsledky dotazu vzestupně nebo sestupně. Výchozí hodnota je "desc" pro časová pole a "asc" pro ostatní.

Name	Typ	Description
asc	string
desc	string

TimeRange

Filtrujte 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