Alerts - Get All

Referentie

Service:: Monitor

API-versie:: 2023-07-12-preview

Alle bestaande waarschuwingen weergeven, waarbij de resultaten kunnen worden gefilterd op basis van meerdere parameters (bijvoorbeeld tijdsbereik). De resultaten kunnen vervolgens worden gesorteerd op basis van specifieke velden, waarbij de standaardwaarde lastModifiedDateTime is.

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

Met optionele 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-parameters

Name	In	Vereist	Type	Description
scope	path	True	string	het bereik hier is resourceId waarvoor de waarschuwing wordt gemaakt.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
alertRule	query		string	Filter op specifieke waarschuwingsregel. De standaardwaarde is om alles te selecteren.
alertState	query		AlertState	Filter op status van het waarschuwingsexemplaren. De standaardwaarde is om alles te selecteren.
customTimeRange	query		string	Filter op aangepast tijdsbereik in de notatie /waar de tijd zich bevindt (ISO-8601-indeling)'. Toegestane waarden zijn binnen 30 dagen na de querytijd. TimeRange of customTimeRange kan worden gebruikt, maar niet beide. De standaardwaarde is geen.
includeContext	query		boolean	Neem context op die contextuele gegevens bevat die specifiek zijn voor de monitorservice. De standaardwaarde is onwaar'
includeEgressConfig	query		boolean	Uitgaande configuratie opnemen die wordt gebruikt voor het weergeven van de inhoud in de portal. De standaardwaarde is 'false'.
monitorCondition	query		MonitorCondition	Filter op monitorvoorwaarde, ofwel 'Geactiveerd' of 'Opgelost'. De standaardwaarde is om alles te selecteren.
monitorService	query		MonitorService	Filter op monitorservice waarmee het waarschuwingsexemplaren worden gegenereerd. Standaardwaarde is alles geselecteerd.
pageCount	query		integer (int64)	Bepaalt het aantal waarschuwingen dat per pagina wordt geretourneerd als reactie. De toegestane waarde ligt tussen 1 en 250. Wanneer het filter includeContent is geselecteerd, is de maximaal toegestane waarde 25. De standaardwaarde is 25.
select	query		string	Met dit filter kunt u de velden (door komma's gescheiden) selecteren die deel uitmaken van de essentiële sectie. Hiermee kunt u alleen de vereiste velden projecteren in plaats van volledige inhoud op te halen. Standaard is het ophalen van alle velden in de sectie Essentials.
severity	query		Severity	Filteren op ernst. Standaardwaarde is alles geselecteerd.
smartGroupId	query		string	Filter de lijst met waarschuwingen op de slimme groeps-id. De standaardwaarde is geen.
sortBy	query		AlertsSortByFields	Sorteer de queryresultaten op invoerveld. De standaardwaarde is lastModifiedDateTime.
sortOrder	query		SortOrder	Sorteer de volgorde van de queryresultaten in oplopend of aflopend. De standaardwaarde is desc voor tijdvelden en asc voor anderen.
targetResource	query		string	Filter op doelresource (dit is volledige ARM-id) De standaardwaarde is alle.
targetResourceGroup	query		string	Filter op naam van de doelresourcegroep. Standaardwaarde is alles geselecteerd.
targetResourceType	query		string	Filteren op doelresourcetype. Standaardwaarde is alles geselecteerd.
timeRange	query		TimeRange	Filter op tijdsbereik op onderstaande waarden. De standaardwaarde is 1 dag.

Antwoorden

Name	Type	Description
200 OK	alertsList	OK. Waarschuwingsobjecten zijn weergegeven.
Other Status Codes	errorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

ListAlerts

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
actionStatus	Actiestatus
alert	Een waarschuwing die is gemaakt in de service voor waarschuwingsbeheer.
alertProperties	Bag met waarschuwingseigenschappen
alertsList	De waarschuwingen weergeven.
AlertsSortByFields	Sorteer de queryresultaten op invoerveld. De standaardwaarde is lastModifiedDateTime.
AlertState	Status van waarschuwingsobject, die door de gebruiker kan worden gewijzigd.
errorResponse	Een foutreactie van de service.
errorResponseBody	Details van foutreactie.
essentials	Dit object bevat consistente velden in verschillende monitorservices.
MonitorCondition	Voorwaarde van de regel bij de monitorservice. Hiermee wordt aangegeven of de onderliggende voorwaarden de gedefinieerde drempelwaarden voor waarschuwingsregels hebben overschreden.
MonitorService	Monitorservice waarop de regel (monitor) is ingesteld.
Severity	De ernst van waarschuwingSv0 is hoog en Sev4 is laag.
SignalType	Het type signaal waarop de waarschuwing is gebaseerd, kan metrische gegevens, logboeken of activiteitenlogboeken zijn.
SortOrder	Sorteer de volgorde van de queryresultaten in oplopend of aflopend. De standaardwaarde is desc voor tijdvelden en asc voor anderen.
TimeRange	Filter op tijdsbereik op onderstaande waarden. De standaardwaarde is 1 dag.

actionStatus

Object

Actiestatus

Name	Type	Description
isSuppressed	boolean	Waarde die aangeeft of de waarschuwing wordt onderdrukt.

alert

Object

Een waarschuwing die is gemaakt in de service voor waarschuwingsbeheer.

Name	Type	Description
id	string	Azure-resource-id
name	string	Azure-resourcenaam
properties	alertProperties	Bag met waarschuwingseigenschappen
type	string	Azure-resourcetype

alertProperties

Object

Bag met waarschuwingseigenschappen

Name	Type	Description
context	object	Informatie die specifiek is voor de monitorservice die meer contextuele informatie over de waarschuwing geeft.
egressConfig	object	Configuratie die wordt gebruikt voor het weergeven van de gegevens in de portal.
essentials	essentials	Dit object bevat consistente velden in verschillende monitorservices.

alertsList

Object

De waarschuwingen weergeven.

Name	Type	Description
nextLink	string	URL voor het ophalen van de volgende set waarschuwingen.
value	alert[]	Lijst met waarschuwingen

AlertsSortByFields

Inventarisatie

Sorteer de queryresultaten op invoerveld. De standaardwaarde is lastModifiedDateTime.

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

AlertState

Inventarisatie

Status van waarschuwingsobject, die door de gebruiker kan worden gewijzigd.

Waarde	Description
Acknowledged
Closed
New

errorResponse

Object

Een foutreactie van de service.

Name	Type	Description
error	errorResponseBody	Details van foutreactie.

errorResponseBody

Object

Details van foutreactie.

Name	Type	Description
code	string	Foutcode, bedoeld om programmatisch te worden gebruikt.
details	errorResponseBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Beschrijving van de fout, bedoeld voor weergave in de gebruikersinterface.
target	string	Doel van de specifieke fout, bijvoorbeeld de naam van de eigenschap.

essentials

Object

Dit object bevat consistente velden in verschillende monitorservices.

Name	Type	Description
actionStatus	actionStatus	Actiestatus
alertRule	string	Regel(monitor) die het waarschuwingsexemplaren heeft geactiveerd. Afhankelijk van de monitorservice is dit een ARM-id of -naam van de regel.
alertState	AlertState	Status van waarschuwingsobject, die door de gebruiker kan worden gewijzigd.
description	string	Beschrijving van waarschuwing.
lastModifiedDateTime	string (date-time)	Laatste wijzigingstijd (ISO-8601-indeling) van waarschuwingsexemplaren.
lastModifiedUserName	string	Gebruiker die de waarschuwing voor het laatst heeft gewijzigd, zou de gebruiker voor het controleren van service-updates 'systeem' zijn, anders de naam van de gebruiker.
monitorCondition	MonitorCondition	Voorwaarde van de regel bij de monitorservice. Hiermee wordt aangegeven of de onderliggende voorwaarden de gedefinieerde drempelwaarden voor waarschuwingsregels hebben overschreden.
monitorConditionResolvedDateTime	string (date-time)	Opgeloste tijd (ISO-8601-indeling) van waarschuwingsexemplaren. Dit wordt bijgewerkt wanneer de monitorservice het waarschuwingsexemplaren oplost omdat niet meer aan de regelvoorwaarde wordt voldaan.
monitorService	MonitorService	Monitorservice waarop de regel (monitor) is ingesteld.
severity	Severity	De ernst van waarschuwingSv0 is hoog en Sev4 is laag.
signalType	SignalType	Het type signaal waarop de waarschuwing is gebaseerd, kan metrische gegevens, logboeken of activiteitenlogboeken zijn.
smartGroupId	string	Unieke id van de slimme groep
smartGroupingReason	string	Uitgebreide reden die de reden beschrijft waarom dit waarschuwingsexemplaren wordt toegevoegd aan een slimme groep
sourceCreatedId	string	Unieke id gemaakt door de monitorservice voor elk waarschuwingsexemplaren. Dit kan worden gebruikt om het probleem bij te houden bij de monitorservice, in het geval van Nagios, Zabbix, SCOM, enzovoort.
startDateTime	string (date-time)	Maaktijd (ISO-8601-indeling) van waarschuwingsexemplaren.
targetResource	string	Doel-ARM-resource, waarop de waarschuwing is gemaakt.
targetResourceGroup	string	Resourcegroep van de ARM-doelresource waarop de waarschuwing is gemaakt.
targetResourceName	string	De naam van de ARM-doelresourcenaam waarop de waarschuwing is gemaakt.
targetResourceType	string	Resourcetype van de ARM-doelresource waarop de waarschuwing is gemaakt.

MonitorCondition

Inventarisatie

Voorwaarde van de regel bij de monitorservice. Hiermee wordt aangegeven of de onderliggende voorwaarden de gedefinieerde drempelwaarden voor waarschuwingsregels hebben overschreden.

Waarde	Description
Fired
Resolved

MonitorService

Inventarisatie

Monitorservice waarop de regel (monitor) is ingesteld.

Waarde	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

Inventarisatie

De ernst van waarschuwingSv0 is hoog en Sev4 is laag.

Waarde	Description
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Inventarisatie

Het type signaal waarop de waarschuwing is gebaseerd, kan metrische gegevens, logboeken of activiteitenlogboeken zijn.

Waarde	Description
Log
Metric
Unknown

SortOrder

Inventarisatie

Sorteer de volgorde van de queryresultaten in oplopend of aflopend. De standaardwaarde is desc voor tijdvelden en asc voor anderen.

Waarde	Description
asc
desc

TimeRange

Inventarisatie

Filter op tijdsbereik op onderstaande waarden. De standaardwaarde is 1 dag.

Waarde	Description
1d
1h
30d
7d

Delen via

Alerts - Get All

URI-parameters

Antwoorden

Voorbeelden

ListAlerts

Voorbeeldaanvraag

Voorbeeldrespons

Definities

actionStatus

alert

alertProperties

alertsList

AlertsSortByFields

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

SortOrder

TimeRange

Aanvullende resources