Alerts - Get All

參考

Service:: Monitor

API Version:: 2023-07-12-preview

列出所有現有的警示，其中結果可以根據多個參數進行篩選 (，例如時間範圍) 。然後，結果可以根據特定欄位排序，預設值為 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

URI 參數

名稱	位於	必要	類型	Description
scope	path	True	string	這裡的範圍是建立警示的 resourceId。
api-version	query	True	string	用於此作業的 API 版本。
alertRule	query		string	依特定警示規則進行篩選。預設值為全部選取。
alertState	query		AlertState	依警示實例的狀態進行篩選。預設值為全部選取。
customTimeRange	query		string	依格式/時間格式的自定義時間範圍進行篩選，其中 time 是 (ISO-8601 格式) 』。允許的值介於查詢時間的30天內。您可以使用 timeRange 或 customTimeRange，但不能同時使用這兩者。預設值為 none。
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	此篩選允許選取 (逗號分隔) 欄位，這會是基本區段的一部分。這隻允許投影必要的欄位，而不是取得整個內容。默認值是擷取 [基本資訊] 區段中的所有欄位。
severity	query		Severity	依嚴重性篩選。預設值為全部選取。
smartGroupId	query		string	依智慧群組標識碼篩選警示清單。預設值為 none。
sortBy	query		AlertsSortByFields	依輸入欄位排序查詢結果，預設值為 'lastModifiedDateTime'。
sortOrder	query		SortOrder	以遞增或遞減方式排序查詢結果順序。時間欄位的預設值為 'desc'，而其他字段則為 'asc'。
targetResource	query		string	依目標資源篩選 ( 完整ARM標識碼) 預設值會全部選取。
targetResourceGroup	query		string	依目標資源組名進行篩選。預設值為全部選取。
targetResourceType	query		string	依目標資源類型進行篩選。預設值為全部選取。
timeRange	query		TimeRange	依下列列出的值依時間範圍進行篩選。預設值為1天。

回應

名稱	類型	Description
200 OK	alertsList	正常。已成功列出警示物件。
Other Status Codes	errorResponse	描述作業失敗原因的錯誤回應。

範例

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

定義

名稱	Description
actionStatus	動作狀態
alert	警示管理服務中建立的警示。
alertProperties	警示屬性包
alertsList	列出警示。
AlertsSortByFields	依輸入欄位排序查詢結果，預設值為 'lastModifiedDateTime'。
AlertState	警示物件狀態，可由使用者修改。
errorResponse	來自服務的錯誤回應。
errorResponseBody	錯誤回應的詳細數據。
essentials	此物件包含不同監視服務之間的一致字段。
MonitorCondition	監視服務的規則條件。它代表基礎條件是否已超過定義的警示規則閾值。
MonitorService	監視規則設定 (監視) 的服務。
Severity	警示 Sev0 最高且 Sev4 為最低嚴重性。
SignalType	警示所依據的訊號類型，可能是計量、記錄或活動記錄。
SortOrder	以遞增或遞減方式排序查詢結果順序。時間欄位的預設值為 'desc'，而其他字段則為 'asc'。
TimeRange	依下列列出的值依時間範圍進行篩選。預設值為1天。

actionStatus

動作狀態

名稱	類型	Description
isSuppressed	boolean	指出是否隱藏警示的值。

alert

警示管理服務中建立的警示。

名稱	類型	Description
id	string	Azure 資源標識碼
name	string	Azure 資源名稱
properties	alertProperties	警示屬性包
type	string	Azure 資源類型

alertProperties

警示屬性包

名稱	類型	Description
context	object	監視服務的特定資訊，可提供更多有關警示的內容詳細數據。
egressConfig	object	用於在入口網站中顯示數據的組態。
essentials	essentials	此物件包含不同監視服務之間的一致字段。

alertsList

列出警示。

名稱	類型	Description
nextLink	string	用來擷取下一組警示的URL。
value	alert[]	警示清單

AlertsSortByFields

依輸入欄位排序查詢結果，預設值為 'lastModifiedDateTime'。

名稱	類型	Description
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

AlertState

警示物件狀態，可由使用者修改。

名稱	類型	Description
Acknowledged	string
Closed	string
New	string

errorResponse

來自服務的錯誤回應。

名稱	類型	Description
error	errorResponseBody	錯誤回應的詳細數據。

errorResponseBody

錯誤回應的詳細數據。

名稱	類型	Description
code	string	錯誤碼，旨在以程序設計方式取用。
details	errorResponseBody[]	錯誤的其他詳細數據清單。
message	string	錯誤的描述，用於顯示在使用者介面中。
target	string	特定錯誤的目標，例如屬性的名稱。

essentials

此物件包含不同監視服務之間的一致字段。

名稱	類型	Description
actionStatus	actionStatus	動作狀態
alertRule	string	規則 (監視引發警示實例) 。視監視服務而定，這會是規則的 ARM 識別碼或名稱。
alertState	AlertState	警示物件狀態，可由使用者修改。
description	string	警示描述。
lastModifiedDateTime	string	上次修改時間 (警示實例的 ISO-8601 格式) 。
lastModifiedUserName	string	上次修改警示的使用者，如果監視服務更新使用者是「系統」，則為「系統」，否則為用戶名稱。
monitorCondition	MonitorCondition	監視服務的規則條件。它代表基礎條件是否已超過定義的警示規則閾值。
monitorConditionResolvedDateTime	string	已解決警示實例 (ISO-8601 格式) 的時間。當監視服務解析警示實例時，這將會更新，因為已不再符合規則條件。
monitorService	MonitorService	監視規則設定 (監視) 的服務。
severity	Severity	警示 Sev0 最高且 Sev4 為最低嚴重性。
signalType	SignalType	警示所依據的訊號類型，可能是計量、記錄或活動記錄。
smartGroupId	string	智慧群組的唯一標識碼
smartGroupingReason	string	描述此警示實例新增至智慧群組的原因詳細資訊原因
sourceCreatedId	string	每個警示實例的監視服務所建立的唯一標識符。在 Nagios、Zabbix、SCOM 等情況下，這可用來追蹤監視服務的問題。
startDateTime	string	建立時間 (警示實例的 ISO-8601 格式) 。
targetResource	string	建立警示的目標 ARM 資源。
targetResourceGroup	string	已建立警示的目標 ARM 資源群組。
targetResourceName	string	建立警示的目標 ARM 資源名稱名稱。
targetResourceType	string	已建立警示的目標 ARM 資源類型。

MonitorCondition

監視服務的規則條件。它代表基礎條件是否已超過定義的警示規則閾值。

名稱	類型	Description
Fired	string
Resolved	string

MonitorService

監視規則設定 (監視) 的服務。

名稱	類型	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

警示 Sev0 最高且 Sev4 為最低嚴重性。

名稱	類型	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SignalType

警示所依據的訊號類型，可能是計量、記錄或活動記錄。

名稱	類型	Description
Log	string
Metric	string
Unknown	string

SortOrder

以遞增或遞減方式排序查詢結果順序。時間欄位的預設值為 'desc'，而其他字段則為 'asc'。

名稱	類型	Description
asc	string
desc	string

TimeRange

依下列列出的值依時間範圍進行篩選。預設值為1天。

名稱	類型	Description
1d	string
1h	string
30d	string
7d	string