共通アラート スキーマCommon alert schema

この記事では、共通アラート スキーマの概要、それを使用する利点、および有効化の方法について説明します。This article describes what the common alert schema is, the benefits of using it and how to enable it.

アラート スキーマとはWhat is the common alert schema?

共通アラート スキーマは、今日の Azure でのアラート通知の使用エクスペリエンスを標準化します。The common alert schema standardizes the consumption experience for alert notifications in Azure today. これまで、今日の Azure の 3 種類のアラート (メトリック、ログ、アクティビティ ログ) は、独自の電子メール テンプレートや Webhook スキーマ などを持ちました。共通アラート スキーマにより、一貫性のあるスキーマでアラート通知を受信できます。Historically, the three alert types in Azure today (metric, log, and activity log) have had their own email templates, webhook schemas, etc. With the common alert schema, you can now receive alert notifications with a consistent schema.

すべてのアラート インスタンスは、影響を受けたリソースおよびアラートの原因について説明します。これらのインスタンスは共通スキーマの次のセクションで説明されています。Any alert instance describes the resource that was affected and the cause of the alert, and these instances are described in the common schema in the following sections:

  • 要点: すべてのアラートの種類において共通の一連の標準化されたフィールド。これらのフィールドでは、アラート対象のリソースと、追加の共通アラート メタデータ (重大度や説明など) が記述されています。Essentials: A set of standardized fields, common across all alert types, which describe what resource the alert is on along with additional common alert metadata (for example, severity or description).
  • アラート コンテキスト: アラートの原因が記述されているフィールドと、アラートの種類に基づいて異なるフィールドのセット。Alert Context: A set of fields which describe the cause of the alert, with fields that vary based on the alert type. たとえば、メトリック アラートの場合はアラート コンテキストのメトリック名やメトリック値などのフィールドがあり、アクティビティ ログ アラートの場合はそのアラートを生成したイベントに関する情報があります。For example, a metric alert would have fields like the metric name and metric value in the alert context, whereas an activity log alert would have information about the event that generated the alert.

ユーザーが使用する一般的な統合シナリオでは、なんらかのピボット (リソース グループなど) に基づいた関心のあるチームに対してアラート インスタンスのルーティングが必要になります。その後、担当のチームがアラートの処理を開始します。The typical integration scenarios we hear from customers involve the routing of the alert instance to the concerned team based on some pivot (for example, resource group), after which the responsible team starts working on it. 共通アラート スキーマを使用すると、必須フィールドを利用することでアラートの種類にわたって標準化されたルーティング ロジックを持つことができ、関心のあるチームがさらに調査を行うために、コンテキスト フィールドをそのままにできます。With the common alert schema, you can have standardized routing logic across alert types by leveraging the essential fields, leaving the context fields as is for the concerned teams to investigate further.

これにより、統合を少なくでき、管理と保守のプロセスを_はるかに_単純なタスクにできます。This means that you can potentially have fewer integrations, making the process of managing and maintaining them a much simpler task. さらに、今後のアラート ペイロードのエンリッチメント (たとえば、カスタマイズや診断のエンリッチメントなど) は共通スキーマで行われます。Additionally, future alert payload enrichments (for example, customization, diagnostic enrichment, etc.) will only surface up in the common schema.

共通アラート スキーマによって強化された機能What enhancements does the common alert schema bring?

共通アラート スキーマは、主にアラート通知で示されます。The common alert schema will primarily manifest itself in your alert notifications. 強化された機能を次に示します。The enhancements that you will see are listed below:

ActionAction 強化された機能Enhancements
smsSMS すべてのアラートの種類における一貫性のある SMS テンプレート。A consistent SMS template for all alert types.
EmailEmail 一貫性のある詳細な電子メール テンプレート。これにより、一目で問題を診断できます。A consistent and detailed email template, allowing you to easily diagnose issues at a glance. ポータルおよび影響を受けるリソース上のアラート インスタンスへの埋め込みディープ リンクにより、即座に修復プロセスに移動できます。Embedded deep-links to the alert instance on the portal and the affected resource ensure that you can quickly jump into the remediation process.
Webhook、Logic App、Azure Function、Automation RunbookWebhook/Logic App/Azure Function/Automation Runbook すべてのアラートの種類における一貫性のある JSON 構造により、異なるアラートの種類にわたって簡単に統合を構築できます。A consistent JSON structure for all alert types, which allows you to easily build integrations across the different alert types.

また、新しいスキーマにより、Azure portal と Azure mobile app の両方で、より優れたアラート使用エクスペリエンスを可能にします。The new schema will also enable a richer alert consumption experience across both the Azure portal and the Azure mobile app in the immediate future.

Webhooks、Logic Apps、Azure Functions、Automation Runbooks のスキーマ定義について説明します。Learn more about the schema definitions for Webhooks/Logic Apps/Azure Functions/Automation Runbooks.

注意

次のアクションでは、共通アラート スキーマはサポートされません。ITSM Connector。The following actions do not support the common alert schema: ITSM Connector.

共通アラート スキーマを有効にする方法How do I enable the common alert schema?

ポータルおよび REST API の両方で、アクション グループを介して共通アラート スキーマにオプトインまたはオプトアウトできます。You can opt in or opt out to the common alert schema through Action Groups, on both the portal and through the REST API. 新しいスキーマへ切り替えるトグルは、アクション レベルで存在します。The toggle to switch to the new schema exists at an action level. たとえば、電子メール アクションと Webhook アクションには個別にオプトインする必要があります。For example, you have to separately opt in for an email action and a webhook action.

注意

  1. 次のアラートの種類では、共通スキーマがデフォルトでサポートされています (オプトインは不要です)。The following alert types support the common schema by default (no opt in required):
    • スマート検出アラートSmart detection alerts
  2. 現在、次のアラートの種類では共通スキーマはサポートされていません。The following alert types currently do not support the common schema:

Azure portal を使用Through the Azure portal

共通アラートスキーマのオプトイン

  1. アクション グループで既存または新規のアクションを開きます。Open any existing or a new action in an action group.
  2. 次に示すように、共通アラート スキーマを有効化するためのトグルで [はい] を選択します。Select ‘Yes’ for the toggle to enable the common alert schema as shown.

Action Groups REST API を使用Through the Action Groups REST API

Action Groups API を使用して共通アラート スキーマにオプトインすることもできます。You can also use the Action Groups API to opt in to the common alert schema. 作成または更新の REST API 呼び出しの実行中に、電子メール、Webhook、Logic Apps、Azure Functions、Automation Runbook のすべてのアクションに対して、フラグ "useCommonAlertSchema" を 'true' (オプトイン) または 'false' (オプトアウト) に設定できます。While making the create or update REST API call, you can set the flag "useCommonAlertSchema" to 'true' (to opt in) or 'false' (to opt out) for any of the following actions - email/webhook/logic app/Azure Function/automation runbook.

たとえば、作成または更新 REST API に対して次の要求本文を実行すると、次の操作が行われます。For example, the following request body made to the create or update REST API will do the following:

  • 電子メール アクション "John Doe's email" に対して共通アラート スキーマを有効にしますEnable the common alert schema for the email action "John Doe's email"
  • 電子メール アクション "Jane Smith's email" に対して共通アラート スキーマを無効にしますDisable the common alert schema for the email action "Jane Smith's email"
  • Webhook アクション "Sample webhook" に対して共通アラート スキーマを有効にしますEnable the common alert schema for the webhook action "Sample webhook"
{
  "properties": {
    "groupShortName": "sample",
    "enabled": true,
    "emailReceivers": [
      {
        "name": "John Doe's email",
        "emailAddress": "johndoe@email.com",
        "useCommonAlertSchema": true
      },
      {
        "name": "Jane Smith's email",
        "emailAddress": "janesmith@email.com",
        "useCommonAlertSchema": false
      }
    ],
    "smsReceivers": [
      {
        "name": "John Doe's mobile",
        "countryCode": "1",
        "phoneNumber": "1234567890"
      },
      {
        "name": "Jane Smith's mobile",
        "countryCode": "1",
        "phoneNumber": "0987654321"
      }
    ],
    "webhookReceivers": [
      {
        "name": "Sample webhook",
        "serviceUri": "http://www.example.com/webhook",
        "useCommonAlertSchema": true
      }
    ]
  },
  "location": "Global",
  "tags": {}
}

次の手順Next steps