在 Azure 監視器中呼叫具有傳統計量警示的 Webhook

發行項
05/28/2023

警告

本文說明如何使用舊版傳統計量警示。 Azure 監視器現在支援近乎即時的計量警示和新的警示體驗。公用雲端使用者已淘汰傳統警示。 Azure Government 雲端和 21Vianet 營運的 Microsoft Azure 傳統警示將於 2024 年 2 月 29 日淘汰。

您可以使用 Webhook 將 Azure 警示通知路由到其他系統以進行後處理或自訂動作。您可以針對警示使用 Webhook，以將警示路由到會傳送簡訊、記錄錯誤、透過聊天或傳訊服務通知小組，或進行其他許多動作的服務。

本文說明如何針對 Azure 計量警示設定 Webhook。文中也會說明 HTTP POST 至 Webhook 的承載資料樣貌。如需有關 Azure 活動記錄警示 (事件警示) 設定和結構描述的詳細資訊，請參閱針對 Azure 活動記錄警示呼叫 Webhook。

Azure 警示會使用 HTTP POST 將警示內容以 JSON 格式傳送到您在建立警示時提供的 Webhook URI。稍後在本文中會定義結構描述。該 URI 必須是有效的 HTTP 或 HTTPS 端點。當警示啟動時，Azure 會針對每個要求張貼一個項目。

透過 Azure 入口網站設定 Webhook

若要在 Azure 入口網站中新增或更新 Webhook URI，請移至 [建立/更新警示]。

您也可以使用 Azure PowerShell Cmdlet、跨平台 CLI 或 Azure 監視器 REST API \(英文\) 設定警示以張貼至 Webhook URI。

驗證 Webhook

Webhook 可透過使用權杖型授權來驗證。儲存的 Webhook URI 含有權杖識別碼。例如： https://mysamplealert/webcallback?tokenid=sometokenid&someparameter=somevalue

承載結構描述

POST 作業對於所有以計量為基礎的警示會包含下列 JSON 承載和結構描述：

{
    "status": "Activated",
    "context": {
        "timestamp": "2015-08-14T22:26:41.9975398Z",
        "id": "/subscriptions/s1/resourceGroups/useast/providers/microsoft.insights/alertrules/ruleName1",
        "name": "ruleName1",
        "description": "some description",
        "conditionType": "Metric",
        "condition": {
            "metricName": "Requests",
            "metricUnit": "Count",
            "metricValue": "10",
            "threshold": "10",
            "windowSize": "15",
            "timeAggregation": "Average",
            "operator": "GreaterThanOrEqual"
        },
        "subscriptionId": "s1",
        "resourceGroupName": "useast",
        "resourceName": "mysite1",
        "resourceType": "microsoft.foo/sites",
        "resourceId": "/subscriptions/s1/resourceGroups/useast/providers/microsoft.foo/sites/mysite1",
        "resourceRegion": "centralus",
        "portalLink": "https://portal.azure.com/#resource/subscriptions/s1/resourceGroups/useast/providers/microsoft.foo/sites/mysite1"
    },
    "properties": {
        "key1": "value1",
        "key2": "value2"
    }
}

欄位	強制性	一組固定值	注意
status	Y	Activated、Resolved	以您設定的條件為基礎的警示狀態。
內容	Y		警示內容。
timestamp	Y		警示觸發的時間。
id	Y		每個警示規則都有唯一的識別碼。
NAME	Y		警示名稱。
description	Y		警示的描述。
conditionType	Y	Metric、Event	支援兩種類型的警示：計量和事件。以計量條件為基礎的計量警示。以活動記錄中的事件為基礎的事件警示。使用此值來檢查警示是以計量或事件為基礎。
condition (條件)	Y		要以 conditionType 值為基礎來檢查的特定欄位。
metricName	用於計量警示		定義規則所監視的計量名稱。
metricUnit	用於計量警示	Bytes、BytesPerSecond、Count、CountPerSecond、Percent、Seconds	計量允許的單位。請參閱允許的值。
metricValue	用於計量警示		造成警示的計量實際值。
threshold	用於計量警示		會啟動警示的臨界值。
windowSize	用於計量警示		以 threshold 為基礎用來監視警示活動的時間長度。值必須介於 5 分鐘到 1 天之間。值必須為 ISO 8601 持續時間格式。
timeAggregation	用於計量警示	Average、Last、Maximum、Minimum、None、Total	收集的資料應如何隨著時間結合。預設值為 Average。請參閱允許的值。
! 運算子之後	用於計量警示		用來比較目前計量資料與所設定臨界值的運算子。
subscriptionId	Y		Azure 訂用帳戶識別碼。
resourceGroupName	Y		受影響資源的資源群組名稱。
resourceName	Y		受影響資源的資源名稱。
resourceType	Y		受影響資源的資源類型。
resourceId	Y		受影響資源的資源識別碼。
resourceRegion	Y		受影響資源的區域或位置。
portalLink	Y		入口網站資源摘要頁面的直接連結。
properties	N	選用	一組索引鍵/值組，具有事件的詳細資料。例如： `Dictionary<String, String>` 。 properties 欄位是選擇性的。在自訂 UI 或邏輯應用程式的工作流程中，使用者可以輸入可透過承載傳遞的索引鍵/值。另一種將自訂屬性傳回給 Webhook 的替代方式是透過 Webhook URI 本身 (做為查詢參數)。

注意

您只能使用 Azure 監視器 REST API \(英文\) 來設定 properties欄位。

後續步驟

請觀賞使用 PagerDuty 整合 Azure 警示 \(英文\) 影片以深入了解 Azure 警示與 Webhook。
深入了解如何對 Azure 警示執行 Azure 自動化指令碼 (Runbook) \(英文\)。
深入了解如何使用邏輯應用程式透過 Twilio 從 Azure 警示傳送簡訊 \(英文\)。
深入了解如何使用邏輯應用程式從 Azure 警示傳送 Slack 訊息 \(英文\)。
深入了解如何使用邏輯應用程式從 Azure 警示將訊息傳送到 Azure 佇列。

共用方式為

在 Azure 監視器中呼叫具有傳統計量警示的 Webhook

透過 Azure 入口網站設定 Webhook

驗證 Webhook

承載結構描述

後續步驟

其他資源