Alerts - Get Summary

Referentie

Service:: Monitor

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

Haal een samengevatte telling van uw waarschuwingen op die zijn gegroepeerd op verschillende parameters (bijvoorbeeld groeperen op Ernst retourneert het aantal waarschuwingen voor elke ernst).

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

Met optionele parameters:

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alertsSummary?groupby={groupby}&includeSmartGroupsCount={includeSmartGroupsCount}&targetResource={targetResource}&targetResourceType={targetResourceType}&targetResourceGroup={targetResourceGroup}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&alertState={alertState}&alertRule={alertRule}&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.
groupby	query	True	AlertsSummaryGroupByFields	Met deze parameter kan de resultatenset worden gegroepeerd op invoervelden (maximaal 2 door komma's gescheiden velden). Bijvoorbeeld groupby=severity of groupby=severity,alertstate.
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.
includeSmartGroupsCount	query		boolean	Neem het aantal SmartGroups op als onderdeel van de samenvatting. 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.
severity	query		Severity	Filteren op ernst. Standaardwaarde is alles geselecteerd.
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	alertsSummary	OK. Waarschuwingsoverzicht geretourneerd.
Other Status Codes	errorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

Summary

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "properties": {
    "groupedby": "severity",
    "smartGroupsCount": 100,
    "total": 14189,
    "values": [
      {
        "name": "Sev0",
        "count": 6517,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 6517
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev1",
        "count": 3175,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 3175
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev2",
        "count": 1120,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1120
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev3",
        "count": 1902,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1902
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev4",
        "count": 1475,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1475
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary/current",
  "type": "Microsoft.AlertsManagement/alertsSummary",
  "name": "current"
}

Definities

Name	Description
alertsSummary	Samenvatting van waarschuwingen op basis van de invoerfilters en groupby-parameters.
alertsSummaryGroup	Groepeer de resultatenset.
AlertsSummaryGroupByFields	Met deze parameter kan de resultatenset worden gegroepeerd op invoervelden (maximaal 2 door komma's gescheiden velden). Bijvoorbeeld groupby=severity of groupby=severity,alertstate.
alertsSummaryGroupItem	Overzichtsgroepitem waarschuwingen
AlertState	Status van waarschuwingsobject, die door de gebruiker kan worden gewijzigd.
errorResponse	Een foutreactie van de service.
errorResponseBody	Details van foutreactie.
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.
TimeRange	Filter op tijdsbereik op onderstaande waarden. De standaardwaarde is 1 dag.

alertsSummary

Object

Samenvatting van waarschuwingen op basis van de invoerfilters en groupby-parameters.

Name	Type	Description
id	string	Azure-resource-id
name	string	Azure-resourcenaam
properties	alertsSummaryGroup	Groepeer de resultatenset.
type	string	Azure-resourcetype

alertsSummaryGroup

Object

Groepeer de resultatenset.

Name	Type	Description
groupedby	string	Naam van het samengevoegde veld
smartGroupsCount	integer (int64)	Totaal aantal slimme groepen.
total	integer (int64)	Totaalaantal van de resultatenset.
values	alertsSummaryGroupItem[]	Lijst met de items

AlertsSummaryGroupByFields

Inventarisatie

Met deze parameter kan de resultatenset worden gegroepeerd op invoervelden (maximaal 2 door komma's gescheiden velden). Bijvoorbeeld groupby=severity of groupby=severity,alertstate.

Waarde	Description
alertRule
alertState
monitorCondition
monitorService
severity
signalType

alertsSummaryGroupItem

Object

Overzichtsgroepitem waarschuwingen

Name	Type	Description
count	integer (int64)	Aantal van het geaggregeerde veld
groupedby	string	Naam van het samengevoegde veld
name	string	Waarde van het geaggregeerde veld
values	alertsSummaryGroupItem[]	Lijst met de items

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.

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

TimeRange

Inventarisatie

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

Waarde	Description
1d
1h
30d
7d

Delen via

Alerts - Get Summary

URI-parameters

Antwoorden

Voorbeelden

Summary

Voorbeeldaanvraag

Voorbeeldrespons

Definities

alertsSummary

alertsSummaryGroup

AlertsSummaryGroupByFields

alertsSummaryGroupItem

AlertState

errorResponse

errorResponseBody

MonitorCondition

MonitorService

Severity

TimeRange

Aanvullende resources