Alerts - Get All

Referencia

Service:: Monitor

API Version:: 2023-07-12-preview

Enumere todas las alertas existentes, donde los resultados se pueden filtrar sobre la base de varios parámetros (por ejemplo, intervalo de tiempo). A continuación, los resultados se pueden ordenar según los campos específicos, con el valor predeterminado lastModifiedDateTime.

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

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

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.
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. TimeRange o customTimeRange se pueden usar, pero no ambos. El valor predeterminado es none.
includeContext	query		boolean	Incluir contexto que tiene datos contextuales específicos del servicio de supervisión. El valor predeterminado es false'
includeEgressConfig	query		boolean	Incluya la configuración de salida que se usaría para mostrar el contenido en el portal. 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.
pageCount	query		integer int64	Determina el número de alertas devueltas por página en respuesta. El valor permitido está comprendido entre 1 y 250. Cuando se selecciona el filtro "includeContent", el valor máximo permitido es 25. El valor predeterminado es de 25.
select	query		string	Este filtro permite seleccionar los campos (separados por comas) que formarían parte de la sección esencial. Esto permitiría proyectar solo los campos necesarios en lugar de obtener todo el contenido. El valor predeterminado es capturar todos los campos de la sección essentials.
severity	query		Severity	Filtre por gravedad. El valor predeterminado es seleccionar todo.
smartGroupId	query		string	Filtre la lista de alertas por el identificador de grupo inteligente. El valor predeterminado no es ninguno.
sortBy	query		AlertsSortByFields	Ordenar los resultados de la consulta por campo de entrada, el valor predeterminado es "lastModifiedDateTime".
sortOrder	query		SortOrder	Ordene el orden de los resultados de la consulta en orden ascendente o descendente. El valor predeterminado es "desc" para los campos de tiempo y "asc" para otros.
targetResource	query		string	Filtrar por recurso de destino( que es el identificador de ARM completo) El valor predeterminado es seleccionar todos.
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	alertsList	Aceptar. Se enumeran correctamente los objetos de alerta.
Other Status Codes	errorResponse	Respuesta de error que describe el motivo del error de la operación.

Ejemplos

ListAlerts

Sample Request

HTTP

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

Sample Response

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

Definiciones

Nombre	Description
actionStatus	Estado de la acción
alert	Una alerta creada en el servicio de administración de alertas.
alertProperties	Contenedor de propiedades de alerta
alertsList	Enumere las alertas.
AlertsSortByFields	Ordenar los resultados de la consulta por campo de entrada, el valor predeterminado es "lastModifiedDateTime".
AlertState	Estado del objeto de alerta, que el usuario puede modificar.
errorResponse	Respuesta de error del servicio.
errorResponseBody	Detalles de la respuesta de error.
essentials	Este objeto contiene campos coherentes en distintos servicios de supervisión.
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.
SignalType	El tipo de señal en la que se basa la alerta, que podría ser métricas, registros o registros de actividad.
SortOrder	Ordene el orden de los resultados de la consulta en orden ascendente o descendente. El valor predeterminado es "desc" para los campos de tiempo y "asc" para otros.
TimeRange	Filtre por intervalo de tiempo por los siguientes valores enumerados. El valor predeterminado es 1 día.

actionStatus

Estado de la acción

Nombre	Tipo	Description
isSuppressed	boolean	Valor que indica si se suprime la alerta.

alert

Una alerta creada en el servicio de administración de alertas.

Nombre	Tipo	Description
id	string	Identificador de recurso de Azure
name	string	Nombre de recurso de Azure
properties	alertProperties	Contenedor de propiedades de alerta
type	string	Tipo de recurso de Azure

alertProperties

Contenedor de propiedades de alerta

Nombre	Tipo	Description
context	object	Información específica del servicio de supervisión que proporciona más detalles contextuales sobre la alerta.
egressConfig	object	Configuración que se usaría para mostrar los datos en el portal.
essentials	essentials	Este objeto contiene campos coherentes en distintos servicios de supervisión.

alertsList

Enumere las alertas.

Nombre	Tipo	Description
nextLink	string	Dirección URL para capturar el siguiente conjunto de alertas.
value	alert[]	Lista de alertas

AlertsSortByFields

Ordenar los resultados de la consulta por campo de entrada, el valor predeterminado es "lastModifiedDateTime".

Nombre	Tipo	Description
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

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.

essentials

Este objeto contiene campos coherentes en distintos servicios de supervisión.

Nombre	Tipo	Description
actionStatus	actionStatus	Estado de la acción
alertRule	string	Rule(monitor) que desencadenó la instancia de alerta. Dependiendo del servicio de supervisión, este sería el identificador de ARM o el nombre de la regla.
alertState	AlertState	Estado del objeto de alerta, que el usuario puede modificar.
description	string	Descripción de la alerta.
lastModifiedDateTime	string	Hora de última modificación (formato ISO-8601) de la instancia de alerta.
lastModifiedUserName	string	El usuario que modificó la alerta por última vez, en caso de que el usuario supervise las actualizaciones del servicio sería "sistema", de lo contrario, el nombre del usuario.
monitorCondition	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.
monitorConditionResolvedDateTime	string	Hora resuelta (formato ISO-8601) de la instancia de alerta. Esto se actualizará cuando el servicio de supervisión resuelva la instancia de alerta porque ya no se cumple la condición de regla.
monitorService	MonitorService	Supervise el servicio en el que se establece la regla (monitor).
severity	Severity	Gravedad de la alerta Sev0 que es más alta y Sev4 es la más baja.
signalType	SignalType	El tipo de señal en la que se basa la alerta, que podría ser métricas, registros o registros de actividad.
smartGroupId	string	Identificador único del grupo inteligente
smartGroupingReason	string	Motivo detallado que describe el motivo por el que se agrega esta instancia de alerta a un grupo inteligente
sourceCreatedId	string	Identificador único creado por el servicio de supervisión para cada instancia de alerta. Esto se podría usar para realizar un seguimiento del problema en el servicio de supervisión, en caso de Nagios, Zabbix, SCOM, etc.
startDateTime	string	Hora de creación (formato ISO-8601) de la instancia de alerta.
targetResource	string	El recurso arm de destino, en el que se creó la alerta.
targetResourceGroup	string	Grupo de recursos de recurso de ARM de destino, en el que se creó la alerta.
targetResourceName	string	Nombre del recurso de ARM de destino, en el que se creó la alerta.
targetResourceType	string	Tipo de recurso de recurso de ARM de destino, en el que se creó la alerta.

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

SignalType

El tipo de señal en la que se basa la alerta, que podría ser métricas, registros o registros de actividad.

Nombre	Tipo	Description
Log	string
Metric	string
Unknown	string

SortOrder

Ordene el orden de los resultados de la consulta en orden ascendente o descendente. El valor predeterminado es "desc" para los campos de tiempo y "asc" para otros.

Nombre	Tipo	Description
asc	string
desc	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