Alerts - Get Summary

Référence

Service:: Monitor

API Version:: 2023-07-12-preview

Obtenez un nombre résumé de vos alertes regroupées par différents paramètres (par exemple, le regroupement par « Gravité » renvoie le nombre d’alertes pour chaque gravité).

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

With optional 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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
scope	path	True	string	l’étendue est ici resourceId pour laquelle l’alerte est créée.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
groupby	query	True	AlertsSummaryGroupByFields	Ce paramètre permet au jeu de résultats d’être regroupé par champs d’entrée (2 champs séparés par des virgules maximum pris en charge). Par exemple, groupby=severity ou groupby=severity,alertstate.
alertRule	query		string	Filtrez par règle d’alerte spécifique. La valeur par défaut consiste à sélectionner tout.
alertState	query		AlertState	Filtrez par état du instance d’alerte. La valeur par défaut consiste à sélectionner tout.
customTimeRange	query		string	Filtrez par intervalle de temps personnalisé au format / où l’heure est au format (format ISO-8601)'. Les valeurs autorisées sont dans les 30 jours suivant l’heure de la requête. TimeRange ou customTimeRange peut être utilisé, mais pas les deux. La valeur par défaut est none.
includeSmartGroupsCount	query		boolean	Incluez le nombre de SmartGroups dans le résumé. La valeur par défaut est « false ».
monitorCondition	query		MonitorCondition	Filtrez par condition de surveillance qui est « Déclenché » ou « Résolu ». La valeur par défaut consiste à sélectionner tout.
monitorService	query		MonitorService	Filtrez en générant le instance d’alerte. La valeur par défaut est sélectionner tout.
severity	query		Severity	Filtrez par gravité. La valeur par défaut est sélectionner tout.
targetResource	query		string	Filtrez par ressource cible( qui est un ID ARM complet) La valeur par défaut est sélectionner tout.
targetResourceGroup	query		string	Filtrez par nom de groupe de ressources cible. La valeur par défaut est sélectionner tout.
targetResourceType	query		string	Filtrez par type de ressource cible. La valeur par défaut est sélectionner tout.
timeRange	query		TimeRange	Filtrez par intervalle de temps selon les valeurs répertoriées ci-dessous. La valeur par défaut est 1 jour.

Réponses

Nom	Type	Description
200 OK	alertsSummary	OK. Résumé de l’alerte retourné.
Other Status Codes	errorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

Summary

Sample Request

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

Sample Response

Status code:: 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"
}

Définitions

Nom	Description
alertsSummary	Résumé des alertes en fonction des filtres d’entrée et des paramètres « groupby ».
alertsSummaryGroup	Regroupez le jeu de résultats.
AlertsSummaryGroupByFields	Ce paramètre permet au jeu de résultats d’être regroupé par champs d’entrée (2 champs séparés par des virgules maximum pris en charge). Par exemple, groupby=severity ou groupby=severity,alertstate.
alertsSummaryGroupItem	Élément de groupe récapitulative des alertes
AlertState	État de l’objet d’alerte, qui peut être modifié par l’utilisateur.
errorResponse	Réponse d’erreur du service.
errorResponseBody	Détails de la réponse d’erreur.
MonitorCondition	Condition de la règle au niveau du service monitor. Il indique si les conditions sous-jacentes ont dépassé les seuils de règle d’alerte définis.
MonitorService	Surveiller le service sur lequel la règle (monitor) est définie.
Severity	Gravité de l’alerte Sev0 étant la plus élevée et Sev4 étant la plus faible.
TimeRange	Filtrez par intervalle de temps selon les valeurs répertoriées ci-dessous. La valeur par défaut est 1 jour.

alertsSummary

Résumé des alertes en fonction des filtres d’entrée et des paramètres « groupby ».

Nom	Type	Description
id	string	ID de ressource Azure
name	string	Nom de la ressource Azure
properties	alertsSummaryGroup	Regroupez le jeu de résultats.
type	string	Type de ressource Azure

alertsSummaryGroup

Regroupez le jeu de résultats.

Nom	Type	Description
groupedby	string	Nom du champ agrégé
smartGroupsCount	integer	Nombre total des groupes intelligents.
total	integer	Nombre total du jeu de résultats.
values	alertsSummaryGroupItem[]	Liste des éléments

AlertsSummaryGroupByFields

Ce paramètre permet au jeu de résultats d’être regroupé par champs d’entrée (2 champs séparés par des virgules maximum pris en charge). Par exemple, groupby=severity ou groupby=severity,alertstate.

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

alertsSummaryGroupItem

Élément de groupe récapitulative des alertes

Nom	Type	Description
count	integer	Nombre de champs agrégés
groupedby	string	Nom du champ agrégé
name	string	Valeur du champ agrégé
values	alertsSummaryGroupItem[]	Liste des éléments

AlertState

État de l’objet d’alerte, qui peut être modifié par l’utilisateur.

Nom	Type	Description
Acknowledged	string
Closed	string
New	string

errorResponse

Réponse d’erreur du service.

Nom	Type	Description
error	errorResponseBody	Détails de la réponse d’erreur.

errorResponseBody

Détails de la réponse d’erreur.

Nom	Type	Description
code	string	Code d’erreur, destiné à être consommé par programmation.
details	errorResponseBody[]	Liste de détails supplémentaires sur l’erreur.
message	string	Description de l’erreur, destinée à être affichée dans l’interface utilisateur.
target	string	Cible de l’erreur particulière, par exemple le nom de la propriété.

MonitorCondition

Condition de la règle au niveau du service monitor. Il indique si les conditions sous-jacentes ont dépassé les seuils de règle d’alerte définis.

Nom	Type	Description
Fired	string
Resolved	string

MonitorService

Surveiller le service sur lequel la règle (monitor) est définie.

Nom	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

Gravité de l’alerte Sev0 étant la plus élevée et Sev4 étant la plus faible.

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

TimeRange

Filtrez par intervalle de temps selon les valeurs répertoriées ci-dessous. La valeur par défaut est 1 jour.

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