Alerts - Get Summary

Referentie

Service:: Monitor

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

Haal een samengevatte telling van uw waarschuwingen op, gegroepeerd op verschillende parameters (groeperen op Ernst retourneert bijvoorbeeld 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	scope hier is resourceId waarvoor de waarschuwing wordt gemaakt.
api-version	query	True	string	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 worden ondersteund). 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	Filteren op aangepast tijdsbereik in de notatie /waarin de tijd zich in (ISO-8601-indeling)' bevindt. Toegestane waarden zijn binnen 30 dagen na de querytijd. TimeRange of customTimeRange kan worden gebruikt, maar niet beide. Standaardinstelling 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 die 'Geactiveerd' of 'Opgelost' is. De standaardwaarde is om alles te selecteren.
monitorService	query		MonitorService	Filter op bewakingsservice die het waarschuwingsexemplaren genereert. De standaardwaarde is Alles selecteren.
severity	query		Severity	Filteren op ernst. De standaardwaarde is Alles selecteren.
targetResource	query		string	Filteren op doelresource (dit is volledige ARM-id) De standaardwaarde is alles selecteren.
targetResourceGroup	query		string	Filter op de naam van de doelresourcegroep. De standaardwaarde is Alles selecteren.
targetResourceType	query		string	Filteren op doelresourcetype. De standaardwaarde is Alles selecteren.
timeRange	query		TimeRange	Filter op tijdsbereik op de 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 worden ondersteund). Bijvoorbeeld groupby=severity of groupby=severity,alertstate.
alertsSummaryGroupItem	Overzichtsgroepsitem waarschuwingen
AlertState	Status van waarschuwingsobject, die door de gebruiker kan worden gewijzigd.
errorResponse	Een foutreactie van de service.
errorResponseBody	Details van de foutreactie.
MonitorCondition	Voorwaarde van de regel bij de bewakingsservice. Hiermee wordt aangegeven of de onderliggende voorwaarden de gedefinieerde drempelwaarden voor waarschuwingsregels hebben overschreden.
MonitorService	Bewaak de service waarop de regel (monitor) is ingesteld.
Severity	De ernst van de waarschuwing Sev0 is het hoogst en Sev4 het laagst.
TimeRange	Filter op tijdsbereik op de onderstaande waarden. De standaardwaarde is 1 dag.

alertsSummary

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

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

alertsSummaryGroup

Groepeer de resultatenset.

Name	Type	Description
groupedby	string	Naam van het geaggregeerde veld
smartGroupsCount	integer	Totale telling van de slimme groepen.
total	integer	Totaalaantal van de resultatenset.
values	alertsSummaryGroupItem[]	Lijst met items

AlertsSummaryGroupByFields

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

Name	Type	Description
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

Overzichtsgroepsitem waarschuwingen

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

AlertState

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

Name	Type	Description
Acknowledged	string
Closed	string
New	string

errorResponse

Een foutreactie van de service.

Name	Type	Description
error	errorResponseBody	Details van de foutreactie.

errorResponseBody

Details van de 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

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

Name	Type	Description
Fired	string
Resolved	string

MonitorService

Bewaak de service waarop de regel (monitor) is ingesteld.

Name	Type	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

De ernst van de waarschuwing Sev0 is het hoogst en Sev4 het laagst.

Name	Type	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

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

Name	Type	Description
1d	string
1h	string
30d	string
7d	string

Delen via