你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	要用于此操作的 API 版本。
alertRule	query		string	按特定警报规则进行筛选。默认值为全选。
alertState	query		AlertState	按警报实例的状态进行筛选。默认值为全选。
customTimeRange	query		string	按格式/（其中时间采用 ISO-8601 格式 () '）的自定义时间范围进行筛选。允许的值为自查询时间起的 30 天内。可以使用 timeRange 或 customTimeRange，但不能同时使用两者。默认为无。
includeContext	query		boolean	包含具有特定于监视服务的上下文数据的上下文。默认值为 false'
includeEgressConfig	query		boolean	包括用于在门户中显示内容的出口配置。默认值为“false”。
monitorCondition	query		MonitorCondition	按“已触发”或“已解决”的监视条件进行筛选。默认值为全选。
monitorService	query		MonitorService	按生成警报实例的监视服务进行筛选。默认值为全选。
pageCount	query		integer int64	确定响应中每页返回的警报数。允许的值为 1 到 250。选择“includeContent”筛选器时，允许的最大值为 25。默认值为 25。
select	query		string	此筛选器允许选择 (逗号分隔) 字段，这些字段将成为基本部分的一部分。这将允许仅投影必填字段，而不是获取整个内容。默认为提取 essentials 节中的所有字段。
severity	query		Severity	按严重性筛选。默认值为全选。
smartGroupId	query		string	按智能组 ID 筛选警报列表。默认值为 none。
sortBy	query		AlertsSortByFields	按输入字段对查询结果进行排序，默认值为“lastModifiedDateTime”。
sortOrder	query		SortOrder	按升序或降序对查询结果进行排序。时间字段的默认值为“desc”，其他字段的默认值为“asc”。
targetResource	query		string	按目标资源筛选 (，这是完整的 ARM ID) 默认值为全选。
targetResourceGroup	query		string	按目标资源组名称进行筛选。默认值为全选。
targetResourceType	query		string	按目标资源类型筛选。默认值为全选。
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

操作状态

名称	类型	说明
isSuppressed	boolean	指示是否禁止显示警报的值。

alert

在警报管理服务中创建的警报。

名称	类型	说明
id	string	Azure 资源 ID
name	string	Azure 资源名称
properties	alertProperties	警报属性包
type	string	Azure 资源类型

alertProperties

警报属性包

名称	类型	说明
context	object	特定于监视服务的信息，可提供有关警报的更多上下文详细信息。
egressConfig	object	用于在门户中显示数据的配置。
essentials	essentials	此对象包含跨不同监视服务的一致字段。

alertsList

列出警报。

名称	类型	说明
nextLink	string	用于提取下一组警报的 URL。
value	alert[]	警报列表

AlertsSortByFields

按输入字段对查询结果进行排序，默认值为“lastModifiedDateTime”。

名称	类型	说明
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

AlertState

警报对象状态，可由用户修改。

名称	类型	说明
Acknowledged	string
Closed	string
New	string

errorResponse

来自服务的错误响应。

名称	类型	说明
error	errorResponseBody	错误响应的详细信息。

errorResponseBody

错误响应的详细信息。

名称	类型	说明
code	string	错误代码，旨在以编程方式使用。
details	errorResponseBody[]	有关错误的其他详细信息的列表。
message	string	错误的说明，用于在用户界面中显示。
target	string	特定错误的目标，例如属性的名称。

essentials

此对象包含跨不同监视服务的一致字段。

名称	类型	说明
actionStatus	actionStatus	操作状态
alertRule	string	规则 (监视触发警报实例) 。根据监视服务，这将是 ARM ID 或规则的名称。
alertState	AlertState	警报对象状态，可由用户修改。
description	string	警报说明。
lastModifiedDateTime	string	上次修改时间 (警报实例的 ISO-8601 格式) 。
lastModifiedUserName	string	上次修改警报的用户（在监视服务更新的情况下）将是“system”，否则为用户的名称。
monitorCondition	MonitorCondition	监视服务中的规则条件。它表示基础条件是否已超过定义的警报规则阈值。
monitorConditionResolvedDateTime	string	已解决警报实例 (ISO-8601 格式) 的时间。当监视服务解决警报实例时，将更新此状态，因为不再满足规则条件。
monitorService	MonitorService	设置规则 (监视) 的监视服务。
severity	Severity	警报的严重性 Sev0 最高，Sev4 为最低。
signalType	SignalType	警报所基于的信号类型，可以是指标、日志或活动日志。
smartGroupId	string	智能组的唯一 ID
smartGroupingReason	string	描述将此警报实例添加到智能组的原因的详细原因
sourceCreatedId	string	监视服务为每个警报实例创建的唯一 ID。这可用于跟踪监视服务中的问题，例如 Nagios、Zabbix、SCOM 等。
startDateTime	string	警报实例的创建时间 (ISO-8601 格式) 。
targetResource	string	创建警报的目标 ARM 资源。
targetResourceGroup	string	创建警报的目标 ARM 资源的资源组。
targetResourceName	string	创建警报的目标 ARM 资源名称的名称。
targetResourceType	string	创建警报的目标 ARM 资源的资源类型。

MonitorCondition

监视服务中的规则条件。它表示基础条件是否已超过定义的警报规则阈值。

名称	类型	说明
Fired	string
Resolved	string

MonitorService

设置规则 (监视) 的监视服务。

名称	类型	说明
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

警报的严重性 Sev0 最高，Sev4 为最低。

名称	类型	说明
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SignalType

警报所基于的信号类型，可以是指标、日志或活动日志。

名称	类型	说明
Log	string
Metric	string
Unknown	string

SortOrder

按升序或降序对查询结果进行排序。时间字段的默认值为“desc”，其他字段的默认值为“asc”。

名称	类型	说明
asc	string
desc	string

TimeRange

按以下列出的值按时间范围进行筛选。默认值为 1 天。

名称	类型	说明
1d	string
1h	string
30d	string
7d	string

通过