Azure Monitor でクラシック メトリック アラートを使用して Webhook を呼び出す

警告

この記事では、古いクラシック メトリック アラートの使用方法について説明します。 Azure Monitor では、新しいほぼリアルタイムのメトリック アラートとアラート エクスペリエンスがサポートされています。 パブリック クラウド ユーザー向けの従来のアラートは廃止されています。 Azure Government クラウドおよび Azure China 21Vianet 向けの従来のアラートは、2024 年 2 月 29 日に廃止されます。

webhook を使用して、後処理やカスタム アクションのために、Azure アラート通知を他のシステムにルーティングすることができます。 SMS メッセージを送信するサービスへのアラートのルーティング、バグの記録、チャットやメッセージング サービスを使用したチームへの通知など、さまざまなアクションに対してアラートで webhook を使用できます。

この記事では、Azure メトリック アラートで webhook を設定する方法について説明します。 また、webhook に対する HTTP POST のペイロードの概要についても説明します。 Azure アクティビティ ログ アラート (イベントでのアラート) の設定とスキーマについては、「Azure アクティビティ ログ アラートでの webhook の呼び出し」を参照してください。

Azure アラートでは、HTTP POST を使用して、JSON 形式のアラート コンテンツを、アラートの作成時に指定した webhook URI に送信します。 スキーマは、この記事の後半で定義されます。 この URI は、有効な HTTP または HTTPS エンドポイントである必要があります。 Azure では、アラートがアクティブ化された場合に要求ごとに 1 つのエントリがポストされます。

Azure Portal を介して webhook を構成する

webhook URI を追加または更新するには、Azure Portal[Create/Update Alerts]\(アラートの作成/更新\) に移動します。

[アラート ルールの追加] ウィンドウ

また、Azure PowerShell コマンドレットクロスプラットフォーム CLI、または Azure Monitor REST API を使用して、webhook URI にポストするアラートを構成することもできます。

webhook の認証

webhook は、トークンベースの承認を使用して認証できます。 webhook URI は、トークン ID を使用して保存されます。 例: 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"
    }
}
フィールド Mandatory 値の固定セット メモ
status Y "Activated"、"Resolved" 設定した条件に基づいたアラートの状態。
context Y アラート コンテキスト。
timestamp Y アラートがトリガーされた時刻。
id Y すべてのアラート ルールには一意の ID があります。
name Y 警告名を指定します。
description Y アラートの説明。
conditionType Y "Metric"、"Event" 2 つの種類のアラート (メトリックとイベント) がサポートされています。 メトリック アラートは、メトリックの条件に基づいています。 イベント アラートは、アクティビティ ログのイベントに基づいています。 この値を使用して、アラートがメトリックとイベントのどちらに基づいているかを確認できます。
condition Y conditionType の値に基づいて確認する特定のフィールド。
metricName メトリック アラートの場合 ルールによる監視対象を定義するメトリックの名前。
metricUnit メトリック アラートの場合 "Bytes"、"BytesPerSecond"、"Count"、"CountPerSecond"、"Percent"、"Seconds" メトリックで使用できる単位。 使用できる値を参照してください。
metricValue メトリック アラートの場合 アラートの原因となったメトリックの実際の値。
threshold メトリック アラートの場合 アラートがアクティブ化されるしきい値。
windowSize メトリック アラートの場合 しきい値に基づいてアラート アクティビティを監視するために使用される期間。 値は 5 分~ 1 日の範囲で指定する必要があります。 値は ISO 8601 の期間の形式である必要があります。
timeAggregation メトリック アラートの場合 "Average"、"Last"、"Maximum"、"Minimum"、"None"、"Total" 収集されたデータの経時的な結合方法。 既定値は Average です。 使用できる値を参照してください。
operator メトリック アラートの場合 設定したしきい値と現在のメトリック データを比較するために使用される演算子。
subscriptionId Y Azure サブスクリプション ID。
resourceGroupName Y 影響を受けるリソースのリソース グループの名前。
resourceName Y 影響を受けるリソースのリソース名。
resourceType Y 影響を受けるリソースの種類。
resourceId Y 影響を受けるリソースのリソース ID。
resourceRegion Y 影響を受けるリソースのリージョンまたは場所。
portalLink Y ポータルのリソースの概要ページへの直接リンク。
properties N オプション イベントに関する詳細を含むキー/値のペアのセット。 たとえば、「 Dictionary<String, String> 」のように入力します。 properties フィールドは省略可能です。 カスタム UI またはロジック アプリベースのワークフローでは、ユーザーは、ペイロードを使用して渡すことのできるキー/値のペアを入力できます。 webhook URI 自体を (クエリ パラメーターとして) 使用して、カスタム プロパティを webhook に戻すこともできます。

Note

properties フィールドは、Azure Monitor REST API を使用してのみ設定できます。

次の手順