Alerts - Get By Id

參考

Service:: Monitor

API Version:: 2023-07-12-preview

取得特定的警示。
取得特定警示的相關信息

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

URI 參數

名稱	位於	必要	類型	Description
alertId	path	True	string	警示實例的唯一標識碼。
scope	path	True	string	這裡的範圍是建立警示的 resourceId。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	alert	正常。傳回具有指定標識碼的警示。
Other Status Codes	errorResponse	描述作業失敗原因的錯誤回應。

範例

GetById

Sample Request

HTTP

GET https://management.azure.com/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100?api-version=2023-07-12-preview

Sample Response

Status code:: 200

{
  "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://sersdfsdfinsight.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	警示屬性包
AlertState	警示物件狀態，可由使用者修改。
errorResponse	來自服務的錯誤回應。
errorResponseBody	錯誤回應的詳細數據。
essentials	此物件包含不同監視服務之間的一致字段。
MonitorCondition	監視服務的規則條件。它代表基礎條件是否已超過定義的警示規則閾值。
MonitorService	監視規則設定 (監視) 的服務。
Severity	警示 Sev0 最高且 Sev4 為最低嚴重性。
SignalType	警示所依據的訊號類型，可能是計量、記錄或活動記錄。

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	此物件包含不同監視服務之間的一致字段。

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

Alerts - Get By Id

URI 參數

回應

範例

GetById

Sample Request

Sample Response

定義

actionStatus

alert

alertProperties

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

其他資源