Alerts - Get All

Ссылка

Служба:: Monitor

Версия API:: 2023-07-12-preview

Список всех существующих оповещений, где результаты можно отфильтровать по нескольким параметрам (например, диапазон времени). Затем результаты можно отсортировать по полям, заданным по умолчанию, lastModifiedDateTime.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
scope	path	True	string	область здесь — resourceId, для которого создается оповещение.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
alertRule	query		string	Фильтрация по определенному правилу генерации оповещений. Значение по умолчанию — выбрать все.
alertState	query		AlertState	Фильтрация по состоянию экземпляра оповещения. Значение по умолчанию — выбрать все.
customTimeRange	query		string	Фильтрация по пользовательскому диапазону времени в формате / где время находится в (формат ISO-8601)". Допустимые значения — в течение 30 дней с момента выполнения запроса. Можно использовать timeRange или customTimeRange, но не оба. Значение по умолчанию — none (Отсутствует).
includeContext	query		boolean	Включите контекст, который содержит контекстные данные, относящиеся к службе мониторинга. Значение по умолчанию — false.
includeEgressConfig	query		boolean	Включите конфигурацию исходящего трафика, которая будет использоваться для отображения содержимого на портале. Значение по умолчанию — false.
monitorCondition	query		MonitorCondition	Фильтрация по условию монитора, которое имеет значение "Сработало" или "Разрешено". Значение по умолчанию — выбрать все.
monitorService	query		MonitorService	Фильтрация по службе мониторинга, которая создает экземпляр оповещения. Значение по умолчанию — select all.
pageCount	query		integer (int64)	Определяет количество оповещений, возвращаемых на каждую страницу в ответе. Допустимое значение — от 1 до 250. Если выбран фильтр includeContent, максимально допустимое значение — 25. Значение по умолчанию равно 25.
select	query		string	Этот фильтр позволяет выбрать поля (разделенные запятыми), которые будут частью основного раздела. Это позволит проецировать только обязательные поля, а не получать все содержимое. По умолчанию используется выборка всех полей в разделе основных компонентов.
severity	query		Severity	Фильтрация по серьезности. Значение по умолчанию — select all.
smartGroupId	query		string	Отфильтруйте список оповещений по идентификатору смарт-группы. Значение по умолчанию — none.
sortBy	query		AlertsSortByFields	Отсортируйте результаты запроса по полю ввода. Значение по умолчанию — lastModifiedDateTime.
sortOrder	query		SortOrder	Отсортируйте результаты запроса по возрастанию или убыванию. Значение по умолчанию — "desc" для полей времени и "asc" для других.
targetResource	query		string	Фильтрация по целевому ресурсу (полный идентификатор ARM). Значение по умолчанию — выбрать все.
targetResourceGroup	query		string	Фильтрация по имени целевой группы ресурсов. Значение по умолчанию — select all.
targetResourceType	query		string	Фильтрация по типу целевого ресурса. Значение по умолчанию — select all.
timeRange	query		TimeRange	Фильтрация по диапазону времени по приведенным ниже значениям. Значение по умолчанию — 1 день.

Ответы

Имя	Тип	Описание
200 OK	alertsList	Все в порядке. Объекты оповещений успешно перечислены.
Other Status Codes	errorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Примеры

ListAlerts

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
    }
  ]
}

Определения

Имя	Описание
actionStatus	Состояние действия
alert	Оповещение, созданное в службе управления оповещениями.
alertProperties	Контейнер свойств оповещений
alertsList	Вывод списка оповещений.
AlertsSortByFields	Отсортируйте результаты запроса по полю ввода. Значение по умолчанию — lastModifiedDateTime.
AlertState	Состояние объекта оповещения, которое может быть изменено пользователем.
errorResponse	Ответ об ошибке от службы.
errorResponseBody	Сведения об ответе на ошибку.
essentials	Этот объект содержит согласованные поля в разных службах мониторинга.
MonitorCondition	Условие правила в службе мониторинга. Он указывает, пересекли ли базовые условия определенные пороговые значения правил генерации оповещений.
MonitorService	Служба мониторинга, для которой задано правило (монитор).
Severity	Уровень серьезности оповещения Sev0 — самый высокий, а Sev4 — самый низкий.
SignalType	Тип сигнала, на котором основано оповещение, который может быть метриками, журналами или журналами действий.
SortOrder	Отсортируйте результаты запроса по возрастанию или убыванию. Значение по умолчанию — "desc" для полей времени и "asc" для других.
TimeRange	Фильтрация по диапазону времени по приведенным ниже значениям. Значение по умолчанию — 1 день.

actionStatus

Object

Состояние действия

Имя	Тип	Описание
isSuppressed	boolean	Значение, указывающее, подавляется ли оповещение.

alert

Object

Оповещение, созданное в службе управления оповещениями.

Имя	Тип	Описание
id	string	Идентификатор ресурса Azure
name	string	Имя ресурса Azure
properties	alertProperties	Контейнер свойств оповещений
type	string	Тип ресурса Azure

alertProperties

Object

Контейнер свойств оповещений

Имя	Тип	Описание
context	object	Сведения, относящиеся к службе мониторинга, которые предоставляют более контекстные сведения об оповещении.
egressConfig	object	Конфигурация, которая будет использоваться для отображения данных на портале.
essentials	essentials	Этот объект содержит согласованные поля в разных службах мониторинга.

alertsList

Object

Вывод списка оповещений.

Имя	Тип	Описание
nextLink	string	URL-адрес для получения следующего набора оповещений.
value	alert[]	Список оповещений

AlertsSortByFields

Перечисление

Отсортируйте результаты запроса по полю ввода. Значение по умолчанию — lastModifiedDateTime.

Значение	Описание
alertState
lastModifiedDateTime
monitorCondition
name
severity
startDateTime
targetResource
targetResourceGroup
targetResourceName
targetResourceType

AlertState

Перечисление

Состояние объекта оповещения, которое может быть изменено пользователем.

Значение	Описание
Acknowledged
Closed
New

errorResponse

Object

Ответ об ошибке от службы.

Имя	Тип	Описание
error	errorResponseBody	Сведения об ответе на ошибку.

errorResponseBody

Object

Сведения об ответе на ошибку.

Имя	Тип	Описание
code	string	Код ошибки, предназначенный для программного использования.
details	errorResponseBody[]	Список дополнительных сведений об ошибке.
message	string	Описание ошибки, предназначенной для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки, например имя свойства.

essentials

Object

Этот объект содержит согласованные поля в разных службах мониторинга.

Имя	Тип	Описание
actionStatus	actionStatus	Состояние действия
alertRule	string	Правило (монитор), которое сработает экземпляр оповещения. В зависимости от службы мониторинга это будет идентификатор ARM или имя правила.
alertState	AlertState	Состояние объекта оповещения, которое может быть изменено пользователем.
description	string	Описание оповещения.
lastModifiedDateTime	string (date-time)	Время последнего изменения (формат ISO-8601) экземпляра оповещения.
lastModifiedUserName	string	Пользователь, который в последний раз изменял оповещение, в случае обновления службы мониторинга пользователь будет "система", в противном случае имя пользователя.
monitorCondition	MonitorCondition	Условие правила в службе мониторинга. Он указывает, пересекли ли базовые условия определенные пороговые значения правил генерации оповещений.
monitorConditionResolvedDateTime	string (date-time)	Разрешенное время (формат ISO-8601) экземпляра оповещения. Он будет обновлен, когда служба мониторинга разрешает экземпляр оповещения, так как условие правила больше не выполняется.
monitorService	MonitorService	Служба мониторинга, для которой задано правило (монитор).
severity	Severity	Уровень серьезности оповещения Sev0 — самый высокий, а Sev4 — самый низкий.
signalType	SignalType	Тип сигнала, на котором основано оповещение, который может быть метриками, журналами или журналами действий.
smartGroupId	string	Уникальный идентификатор смарт-группы
smartGroupingReason	string	Подробная причина, описывающая причину добавления этого экземпляра оповещения в смарт-группу
sourceCreatedId	string	Уникальный идентификатор, созданный службой мониторинга для каждого экземпляра оповещения. Это можно использовать для отслеживания проблемы в службе мониторинга, в случае Nagios, Zabbix, SCOM и т. д.
startDateTime	string (date-time)	Время создания (формат ISO-8601) экземпляра оповещения.
targetResource	string	Целевой ресурс ARM, для которого было создано оповещение.
targetResourceGroup	string	Группа ресурсов целевого ресурса ARM, для которой было создано оповещение.
targetResourceName	string	Имя целевого ресурса ARM, для которого было создано оповещение.
targetResourceType	string	Тип ресурса целевого ресурса ARM, для которого было создано оповещение.

MonitorCondition

Перечисление

Условие правила в службе мониторинга. Он указывает, пересекли ли базовые условия определенные пороговые значения правил генерации оповещений.

Значение	Описание
Fired
Resolved

MonitorService

Перечисление

Служба мониторинга, для которой задано правило (монитор).

Значение	Описание
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

Перечисление

Уровень серьезности оповещения Sev0 — самый высокий, а Sev4 — самый низкий.

Значение	Описание
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Перечисление

Тип сигнала, на котором основано оповещение, который может быть метриками, журналами или журналами действий.

Значение	Описание
Log
Metric
Unknown

SortOrder

Перечисление

Отсортируйте результаты запроса по возрастанию или убыванию. Значение по умолчанию — "desc" для полей времени и "asc" для других.

Значение	Описание
asc
desc

TimeRange

Перечисление

Фильтрация по диапазону времени по приведенным ниже значениям. Значение по умолчанию — 1 день.

Значение	Описание
1d
1h
30d
7d

Поделиться через

Alerts - Get All

Параметры URI

Ответы

Примеры

ListAlerts

Образец запроса

Пример ответа

Определения

actionStatus

alert

alertProperties

alertsList

AlertsSortByFields

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

SortOrder

TimeRange

Дополнительные ресурсы