Alerts - Get All

Referencia

Szolgáltatás:: Monitor

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

Sorolja fel 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 pedig a lastModifiedDateTime.

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

Opcionális paraméterekkel:

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 minLength: 1	A művelethez használni kívánt 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űrés 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 abban a formátumban/ ahol az idő szerepel (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 nincs.
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ő konfiguráció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" állapotú. Az alapértelmezett érték az összes kijelölése.
monitorService	query		MonitorService	Szűrés a riasztáspéldányt létrehozó monitorozási szolgáltatás alapján. 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. Így a teljes tartalom beolvasása helyett csak a szükséges mezőket vetíthet 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	A lekérdezési eredmények rendezése beviteli mező szerint, az alapértelmezett érték a "lastModifiedDateTime".
sortOrder	query		SortOrder	A lekérdezés eredményének rendezése növekvő vagy csökkenő sorrendben. Az alapértelmezett érték az időmezők "desc" értéke, másoknál pedig az "asc".
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űrés időtartomány szerint az alábbi értékek szerint. Az alapértelmezett érték 1 nap.

Válaszok

Name	Típus	Description
200 OK	alertsList	OKÉ. Sikeresen felsorolt riasztási objektumok.
Other Status Codes	errorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Példák

ListAlerts

Mintakérelem

HTTP

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

Mintaválasz

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

Definíciók

Name	Description
actionStatus	Művelet állapota
alert	Riasztás a riasztáskezelési szolgáltatásban.
alertProperties	Riasztás tulajdonság táska
alertsList	Sorolja fel a riasztásokat.
AlertsSortByFields	A lekérdezési eredmények rendezése beviteli 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 az alapul szolgáló 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	A riasztási Sev0 súlyossága a legmagasabb, a Sev4 pedig a legalacsonyabb.
SignalType	A riasztás alapjául szolgáló jelzés típusa lehet metrikák, naplók vagy tevékenységnaplók.
SortOrder	A lekérdezés eredményének rendezése növekvő vagy csökkenő sorrendben. Az alapértelmezett érték az időmezők "desc" értéke, másoknál pedig az "asc".
TimeRange	Szűrés időtartomány szerint az alábbi értékek szerint. Az alapértelmezett érték 1 nap.

actionStatus

Objektum

Művelet állapota

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

alert

Objektum

Riasztás a riasztáskezelési szolgáltatásban.

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

Objektum

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ére szolgál.
essentials	essentials	Ez az objektum konzisztens mezőket tartalmaz a különböző figyelőszolgáltatásokban.

alertsList

Objektum

Sorolja fel a riasztásokat.

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

Enumerálás

A lekérdezési eredmények rendezése beviteli mező szerint, az alapértelmezett érték a "lastModifiedDateTime".

Érték	Description
alertState
lastModifiedDateTime
monitorCondition
name
severity
startDateTime
targetResource
targetResourceGroup
targetResourceName
targetResourceType

AlertState

Enumerálás

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

Érték	Description
Acknowledged
Closed
New

errorResponse

Objektum

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

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

errorResponseBody

Objektum

A hibaválasz részletei.

Name	Típus	Description
code	string	Hibakód, amely programozott módon használható.
details	errorResponseBody[]	A hiba további részleteinek 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

Objektum

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	A riasztáspéldányt aktiváló szabály(figyelő). 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 (date-time)	A riasztáspéldány utolsó módosítási ideje (ISO-8601 formátum).
lastModifiedUserName	string	A riasztást utoljára módosító felhasználó a szolgáltatásfrissítések figyelése 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 az alapul szolgáló feltételek átlépték-e a riasztási szabály meghatározott küszöbértékeit.
monitorConditionResolvedDateTime	string (date-time)	A riasztáspéldány feloldott ideje (ISO-8601 formátum). Ez akkor frissül, ha a monitorozási szolgáltatás feloldja a riasztáspé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	A riasztási Sev0 súlyossága a legmagasabb, a Sev4 pedig a legalacsonyabb.
signalType	SignalType	A riasztás alapjául szolgáló jelzés 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 miért lett hozzáadva ez a riasztási példány 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 (date-time)	A 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étrejött.
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étrejött.

MonitorCondition

Enumerálás

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

Érték	Description
Fired
Resolved

MonitorService

Enumerálás

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

Érték	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

Enumerálás

A riasztási Sev0 súlyossága a legmagasabb, a Sev4 pedig a legalacsonyabb.

Érték	Description
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Enumerálás

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

Érték	Description
Log
Metric
Unknown

SortOrder

Enumerálás

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

Érték	Description
asc
desc

TimeRange

Enumerálás

Szűrés időtartomány szerint az alábbi értékek szerint. Az alapértelmezett érték 1 nap.

Érték	Description
1d
1h
30d
7d

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

Alerts - Get All

URI-paraméterek

Válaszok

Példák

ListAlerts

Mintakérelem

Mintaválasz

Definíciók

actionStatus

alert

alertProperties

alertsList

AlertsSortByFields

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

SortOrder

TimeRange

További források