Alerts - Get All

Reference

Služba:: Monitor

Verze rozhraní API:: 2023-07-12-preview

Vypsat všechny existující výstrahy, ve kterých je možné výsledky filtrovat na základě více parametrů (např. časového rozsahu). Výsledky je pak možné řadit podle konkrétních polí s výchozím nastavením lastModifiedDateTime.

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

S volitelnými parametry:

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	scope here is resourceId for which alert is created.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
alertRule	query		string	Filtrovat podle konkrétního pravidla upozornění Výchozí hodnota je vybrat vše.
alertState	query		AlertState	Vyfiltrujte podle stavu instance výstrahy. Výchozí hodnota je vybrat vše.
customTimeRange	query		string	Filtrovat podle vlastního časového rozsahu ve formátu / kde je čas ve formátu (formát ISO-8601)'. Přípustné hodnoty jsou do 30 dnů od času dotazu. Je možné použít buď timeRange, nebo customTimeRange, ale ne obojí. Výchozí hodnota není žádná.
includeContext	query		boolean	Uveďte kontext, který má 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 aktivovaná nebo Vyřešená. Výchozí hodnota je vybrat vše.
monitorService	query		MonitorService	Vyfiltrujte podle služby monitorování, která generuje instanci výstrahy. Výchozí hodnota je vybrána vše.
pageCount	query		integer (int64)	Určuje počet upozornění vrácených na stránku v odpovědi. Povolená hodnota je mezi 1 až 250. Pokud je vybrán filtr includeContent, maximální povolená hodnota je 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 projektovat pouze požadovaná pole, a ne získat celý obsah. 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 vybrána vše.
smartGroupId	query		string	Filtrujte seznam výstrah podle ID inteligentní skupiny. Výchozí hodnota není žádná.
sortBy	query		AlertsSortByFields	Výsledky dotazu seřadí podle vstupního pole, výchozí hodnota je lastModifiedDateTime.
sortOrder	query		SortOrder	Seřaďte pořadí výsledků 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 vybrána všechny.
targetResourceGroup	query		string	Filtrujte podle názvu cílové skupiny prostředků. Výchozí hodnota je vybrána vše.
targetResourceType	query		string	Filtrovat podle typu cílového prostředku Výchozí hodnota je vybrána 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	alertsList	OK. Objekty výstrah byly úspěšně uvedeny.
Other Status Codes	errorResponse	Chybová odpověď popisující, proč operace selhala.

Příklady

ListAlerts

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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ě pro správu výstrah
alertProperties	Taška vlastností upozornění
alertsList	Vypsat výstrahy
AlertsSortByFields	Výsledky dotazu seřadí podle vstupního pole, výchozí hodnota je lastModifiedDateTime.
AlertState	Stav objektu výstrahy, který může uživatel upravit.
errorResponse	Chybová odpověď ze služby.
errorResponseBody	Podrobnosti o odpovědi na chybu
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, zda základní podmínky překročily prahové hodnoty definovaného pravidla upozornění.
MonitorService	Monitorování služby, na které je nastavené pravidlo (monitorování).
Severity	Závažnost výstrahy Sev0 je nejvyšší a úroveň Sev4 je nejnižší.
SignalType	Typ signálu, na kterém je výstraha založená, což může být metrika, protokoly nebo protokoly aktivit.
SortOrder	Seřaďte pořadí výsledků dotazu vzestupně nebo sestupně. Výchozí hodnota je "desc" pro časová pole a "asc" pro ostatní.
TimeRange	Filtrovat podle časového rozsahu podle níže uvedených hodnot. Výchozí hodnota je 1 den.

actionStatus

Objekt

Stav akce

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

alert

Objekt

Výstraha vytvořená ve službě pro správu výstrah

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

alertProperties

Objekt

Taška vlastností upozornění

Name	Typ	Description
context	object	Informace specifické pro službu monitorování, která poskytuje více kontextových podrobností o upozornění.
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

Objekt

Vypsat výstrahy

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

AlertsSortByFields

Výčet

Výsledky dotazu seřadí podle vstupního pole, výchozí hodnota je lastModifiedDateTime.

Hodnota	Description
alertState
lastModifiedDateTime
monitorCondition
name
severity
startDateTime
targetResource
targetResourceGroup
targetResourceName
targetResourceType

AlertState

Výčet

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

Hodnota	Description
Acknowledged
Closed
New

errorResponse

Objekt

Chybová odpověď ze služby.

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

errorResponseBody

Objekt

Podrobnosti o odpovědi na chybu

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

essentials

Objekt

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á aktivovala instanci výstrahy. V závislosti na monitorovací službě by to bylo ID ARM nebo název pravidla.
alertState	AlertState	Stav objektu výstrahy, který může uživatel upravit.
description	string	Popis výstrahy
lastModifiedDateTime	string (date-time)	Čas poslední změny (formát ISO-8601) instance výstrahy.
lastModifiedUserName	string	Uživatel, který výstrahu naposledy upravil, v případě aktualizace monitoru by uživatel byl "systém", jinak jméno uživatele.
monitorCondition	MonitorCondition	Podmínka pravidla ve službě monitorování Představuje, zda základní podmínky překročily prahové hodnoty definovaného pravidla upozornění.
monitorConditionResolvedDateTime	string (date-time)	Vyřešený čas (formát ISO-8601) instance výstrahy. Tato aktualizace se aktualizuje, když služba monitorování vyřeší instanci výstrahy, protože podmínka pravidla již není splněna.
monitorService	MonitorService	Monitorování služby, na které je nastavené pravidlo (monitorování).
severity	Severity	Závažnost výstrahy Sev0 je nejvyšší a úroveň Sev4 je nejnižší.
signalType	SignalType	Typ signálu, na kterém je výstraha založená, což může být metrika, 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 výstrahy do inteligentní skupiny
sourceCreatedId	string	Jedinečné ID vytvořené službou monitorování pro každou instanci výstrahy. To lze použít ke sledování problému ve službě monitorování, v případě Nagios, Zabbix, SCOM atd.
startDateTime	string (date-time)	Čas vytvoření (formát ISO-8601) instance výstrahy
targetResource	string	Cílový prostředek ARM, na kterém se výstraha vytvořila.
targetResourceGroup	string	Skupina prostředků cílového prostředku ARM, na kterém se výstraha vytvořila.
targetResourceName	string	Název cílového názvu prostředku ARM, na kterém se výstraha vytvořila.
targetResourceType	string	Typ prostředku cílového prostředku ARM, na kterém se vytvořila výstraha.

MonitorCondition

Výčet

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

Hodnota	Description
Fired
Resolved

MonitorService

Výčet

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

Hodnota	Description
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

Výčet

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

Hodnota	Description
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Výčet

Typ signálu, na kterém je výstraha založená, což může být metrika, protokoly nebo protokoly aktivit.

Hodnota	Description
Log
Metric
Unknown

SortOrder

Výčet

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

Hodnota	Description
asc
desc

TimeRange

Výčet

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

Hodnota	Description
1d
1h
30d
7d

Sdílet prostřednictvím

Alerts - Get All

Parametry identifikátoru URI

Odpovědi

Příklady

ListAlerts

Ukázkový požadavek

Ukázková odpověď

Definice

actionStatus

alert

alertProperties

alertsList

AlertsSortByFields

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

SortOrder

TimeRange

Další materiály