Alerts - Get Summary

Referencia

Service:: Monitor

API Version:: 2023-07-12-preview

Obtenga un recuento resumido de las alertas agrupadas por varios parámetros (por ejemplo, la agrupación por "Gravedad" devuelve el recuento de alertas para cada gravedad).

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
scope	path	True	string	el ámbito aquí es resourceId para el que se crea la alerta.
api-version	query	True	string	Versión de API que se usará para la operación.
groupby	query	True	AlertsSummaryGroupByFields	Este parámetro permite que el conjunto de resultados se agrupe por campos de entrada (se admite un máximo de 2 campos separados por comas). Por ejemplo, groupby=severity o groupby=severity,alertstate.
alertRule	query		string	Filtre por regla de alerta específica. El valor predeterminado es seleccionar todo.
alertState	query		AlertState	Filtre por estado de la instancia de alerta. El valor predeterminado es seleccionar todo.
customTimeRange	query		string	Filtre por intervalo de tiempo personalizado en el formato o donde la hora esté en formato ISO-8601". Los valores permitidos se encuentran en un plazo de 30 días a partir del tiempo de consulta. Se puede usar timeRange o customTimeRange, pero no ambos. El valor predeterminado es none.
includeSmartGroupsCount	query		boolean	Incluya el recuento de SmartGroups como parte del resumen. El valor predeterminado es "false".
monitorCondition	query		MonitorCondition	Filtre por condición de supervisión que sea "Desencadenada" o "Resuelta". El valor predeterminado es seleccionar todo.
monitorService	query		MonitorService	Filtre por servicio de supervisión que genere la instancia de alerta. El valor predeterminado es seleccionar todo.
severity	query		Severity	Filtre por gravedad. El valor predeterminado es seleccionar todo.
targetResource	query		string	Filtrar por recurso de destino( que es el id. de ARM completo) El valor predeterminado es seleccionar todo.
targetResourceGroup	query		string	Filtre por nombre del grupo de recursos de destino. El valor predeterminado es seleccionar todo.
targetResourceType	query		string	Filtre por tipo de recurso de destino. El valor predeterminado es seleccionar todo.
timeRange	query		TimeRange	Filtre por intervalo de tiempo por los siguientes valores enumerados. El valor predeterminado es 1 día.

Respuestas

Nombre	Tipo	Description
200 OK	alertsSummary	Aceptar. Resumen de alerta devuelto.
Other Status Codes	errorResponse	Respuesta de error que describe el motivo del error de la operación.

Ejemplos

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"
}

Definiciones

Nombre	Description
alertsSummary	Resumen de las alertas basadas en los filtros de entrada y los parámetros "groupby".
alertsSummaryGroup	Agrupe el conjunto de resultados.
AlertsSummaryGroupByFields	Este parámetro permite que el conjunto de resultados se agrupe por campos de entrada (se admite un máximo de 2 campos separados por comas). Por ejemplo, groupby=severity o groupby=severity,alertstate.
alertsSummaryGroupItem	Elemento de grupo de resumen de alertas
AlertState	Estado del objeto de alerta, que el usuario puede modificar.
errorResponse	Respuesta de error del servicio.
errorResponseBody	Detalles de la respuesta de error.
MonitorCondition	Condición de la regla en el servicio de supervisión. Representa si las condiciones subyacentes han superado los umbrales de regla de alerta definidos.
MonitorService	Supervise el servicio en el que se establece la regla (monitor).
Severity	Gravedad de la alerta Sev0 que es más alta y Sev4 es la más baja.
TimeRange	Filtre por intervalo de tiempo por los siguientes valores enumerados. El valor predeterminado es 1 día.

alertsSummary

Resumen de las alertas basadas en los filtros de entrada y los parámetros "groupby".

Nombre	Tipo	Description
id	string	Identificador de recurso de Azure
name	string	Nombre de recurso de Azure
properties	alertsSummaryGroup	Agrupe el conjunto de resultados.
type	string	Tipo de recurso de Azure

alertsSummaryGroup

Agrupe el conjunto de resultados.

Nombre	Tipo	Description
groupedby	string	Nombre del campo agregado
smartGroupsCount	integer	Recuento total de los grupos inteligentes.
total	integer	Recuento total del conjunto de resultados.
values	alertsSummaryGroupItem[]	Lista de los elementos

AlertsSummaryGroupByFields

Este parámetro permite que el conjunto de resultados se agrupe por campos de entrada (se admite un máximo de 2 campos separados por comas). Por ejemplo, groupby=severity o groupby=severity,alertstate.

Nombre	Tipo	Description
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

Elemento de grupo de resumen de alertas

Nombre	Tipo	Description
count	integer	Recuento del campo agregado
groupedby	string	Nombre del campo agregado
name	string	Valor del campo agregado
values	alertsSummaryGroupItem[]	Lista de los elementos

AlertState

Estado del objeto de alerta, que el usuario puede modificar.

Nombre	Tipo	Description
Acknowledged	string
Closed	string
New	string

errorResponse

Respuesta de error del servicio.

Nombre	Tipo	Description
error	errorResponseBody	Detalles de la respuesta de error.

errorResponseBody

Detalles de la respuesta de error.

Nombre	Tipo	Description
code	string	Código de error, diseñado para consumirse mediante programación.
details	errorResponseBody[]	Lista de detalles adicionales sobre el error.
message	string	Descripción del error, destinado a mostrarse en la interfaz de usuario.
target	string	Destino del error concreto, por ejemplo nombre de la propiedad.

MonitorCondition

Condición de la regla en el servicio de supervisión. Representa si las condiciones subyacentes han superado los umbrales de regla de alerta definidos.

Nombre	Tipo	Description
Fired	string
Resolved	string

MonitorService

Supervise el servicio en el que se establece la regla (monitor).

Nombre	Tipo	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

Gravedad de la alerta Sev0 que es más alta y Sev4 es la más baja.

Nombre	Tipo	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

Filtre por intervalo de tiempo por los siguientes valores enumerados. El valor predeterminado es 1 día.

Nombre	Tipo	Description
1d	string
1h	string
30d	string
7d	string

Compartir a través de