Alerts - Get All

Referencia

Service:: Monitor

API Version:: 2023-07-12-preview

Listázhatja az összes meglévő riasztást, ahol az eredmények több paraméter (például időtartomány) alapján szűrhetők. Az eredmények ezután az adott mezők alapján rendezhetők, az alapértelmezett érték a 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

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ó.
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.
includeContext	query		boolean	Olyan környezet belefoglalása, amely a monitorozási szolgáltatásra jellemző környezeti adatokkal rendelkezik. Az alapértelmezett érték hamis"
includeEgressConfig	query		boolean	Adja meg a kimenő forgalom konfigurációját, amely a tartalom portálon való megjelenítéséhez használható. 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.
pageCount	query		integer int64	A válaszként visszaadott riasztások számát határozza meg. A megengedett érték 1 és 250 között van. Ha az "includeContent" szűrő van kiválasztva, az engedélyezett maximális érték 25. Az alapértelmezett érték 25.
select	query		string	Ez a szűrő lehetővé teszi az alapvető szakasz részét képező mezők (vesszővel elválasztott) kiválasztását. Ez lehetővé teszi, hogy a teljes tartalom beolvasása helyett csak a szükséges mezőket vetítse ki. Az alapértelmezett érték az alapvető adatok szakasz összes mezőjének beolvasása.
severity	query		Severity	Szűrés súlyosság szerint. Az alapértelmezett érték az összes kijelölése.
smartGroupId	query		string	Szűrje a riasztások listáját az intelligens csoportazonosító alapján. Az alapértelmezett érték nincs.
sortBy	query		AlertsSortByFields	Rendezze a lekérdezési eredményeket bemeneti mező szerint, az alapértelmezett érték a "lastModifiedDateTime".
sortOrder	query		SortOrder	A lekérdezés eredményének sorrendje növekvő vagy csökkenő sorrendben. Az alapértelmezett érték az időmezők "desc" értéke, másoknál az "asc" érték.
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	alertsList	OK gombra. Sikeresen listázta a riasztási objektumokat.
Other Status Codes	errorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Példák

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

Definíciók

Name	Description
actionStatus	Művelet állapota
alert	A riasztáskezelő szolgáltatásban létrehozott riasztás.
alertProperties	Riasztás tulajdonság táska
alertsList	A riasztások listázása.
AlertsSortByFields	Rendezze a lekérdezési eredményeket bemeneti mező szerint, az alapértelmezett érték a "lastModifiedDateTime".
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.
essentials	Ez az objektum konzisztens mezőket tartalmaz a különböző figyelőszolgáltatásokban.
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.
SignalType	A riasztás alapjául szolgáló jel típusa lehet metrikák, naplók vagy tevékenységnaplók.
SortOrder	A lekérdezés eredményének sorrendje növekvő vagy csökkenő sorrendben. Az alapértelmezett érték az időmezők "desc" értéke, másoknál az "asc" érték.
TimeRange	Szűrjön időtartomány szerint az alábbi felsorolt értékek szerint. Az alapértelmezett érték 1 nap.

actionStatus

Művelet állapota

Name	Típus	Description
isSuppressed	boolean	Érték, amely azt jelzi, hogy a riasztás el van-e tiltva.

alert

A riasztáskezelő szolgáltatásban létrehozott riasztás.

Name	Típus	Description
id	string	Azure-erőforrás azonosítója
name	string	Azure-erőforrás neve
properties	alertProperties	Riasztás tulajdonság táska
type	string	Azure-erőforrástípus

alertProperties

Riasztás tulajdonság táska

Name	Típus	Description
context	object	A monitorozási szolgáltatásra vonatkozó információk, amelyek részletesebb információkat adnak a riasztásról.
egressConfig	object	Konfiguráció, amely az adatok portálon való megjelenítéséhez használható.
essentials	essentials	Ez az objektum konzisztens mezőket tartalmaz a különböző figyelőszolgáltatásokban.

alertsList

A riasztások listázása.

Name	Típus	Description
nextLink	string	URL-cím a következő riasztáskészlet lekéréséhez.
value	alert[]	Riasztások listája

AlertsSortByFields

Rendezze a lekérdezési eredményeket bemeneti mező szerint, az alapértelmezett érték a "lastModifiedDateTime".

Name	Típus	Description
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

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.

essentials

Ez az objektum konzisztens mezőket tartalmaz a különböző figyelőszolgáltatásokban.

Name	Típus	Description
actionStatus	actionStatus	Művelet állapota
alertRule	string	Szabály(monitor), amely aktiválta a riasztáspéldányt. A monitorozási szolgáltatástól függően ez a szabály ARM-azonosítója vagy neve.
alertState	AlertState	Riasztási objektum állapota, amelyet a felhasználó módosíthat.
description	string	Riasztás leírása.
lastModifiedDateTime	string	A riasztáspéldány utolsó módosítási időpontja (ISO-8601 formátum).
lastModifiedUserName	string	A riasztást utoljára módosító felhasználó a szolgáltatásfrissítések monitorozása esetén a felhasználó "rendszer", ellenkező esetben a felhasználó neve.
monitorCondition	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.
monitorConditionResolvedDateTime	string	A riasztási példány feloldott ideje (ISO-8601 formátum). Ez akkor frissül, ha a monitorozási szolgáltatás feloldja a riasztási példányt, mert a szabályfeltétel már nem teljesül.
monitorService	MonitorService	Monitorozási szolgáltatás, amelyen a szabály(monitor) be van állítva.
severity	Severity	Az Sev0 riasztás súlyossága a legmagasabb, az Sev4 pedig a legalacsonyabb.
signalType	SignalType	A riasztás alapjául szolgáló jel típusa lehet metrikák, naplók vagy tevékenységnaplók.
smartGroupId	string	Az intelligens csoport egyedi azonosítója
smartGroupingReason	string	Részletes ok, amely leírja, hogy a riasztási példány miért van hozzáadva egy intelligens csoporthoz
sourceCreatedId	string	A monitorozási szolgáltatás által az egyes riasztáspéldányokhoz létrehozott egyedi azonosító. Ezzel nyomon követhető a probléma a monitorozási szolgáltatásban, Nagios, Zabbix, SCOM stb. esetén.
startDateTime	string	Riasztáspéldány létrehozási ideje (ISO-8601 formátum).
targetResource	string	Cél ARM-erőforrás, amelyen a riasztás létre lett hozva.
targetResourceGroup	string	A cél ARM-erőforrás erőforráscsoportja, amelyen a riasztás létre lett hozva.
targetResourceName	string	A cél ARM-erőforrás neve, amelyen a riasztás létre lett hozva.
targetResourceType	string	A cél ARM-erőforrás erőforrástípusa, amelyen a riasztás létre lett hozva.

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

SignalType

A riasztás alapjául szolgáló jel típusa lehet metrikák, naplók vagy tevékenységnaplók.

Name	Típus	Description
Log	string
Metric	string
Unknown	string

SortOrder

A lekérdezés eredményének sorrendje növekvő vagy csökkenő sorrendben. Az alapértelmezett érték az időmezők "desc" értéke, másoknál az "asc" érték.

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

Share via