従来の Log Analytics Alert API から Scheduled Query Rules API にアップグレードする

  • [アーティクル]

重要

お知らせのとおり、Log Analytics Alert API は 2025 年 10 月 1 日に廃止されます。 この日までに、ログ検索アラートのために Scheduled Query Rules API の使用に移行する必要があります。 2019 年 6 月 1 日以降に作成された Log Analytics ワークスペースは、ScheduledQueryRules API を使用してアラート ルールを管理します。 より古いワークスペースは、Azure Monitor の scheduledQueryRules のメリットを活用するために現在の API に切り替えてください。 ルールを scheduledQueryRules API に移行すると、古い従来の Log Analytics アラート API に戻すことはできません。

以前は、ユーザーは従来の Log Analytics Alert API を使用して、ログ検索アラート ルールを管理していました。 現在では、ワークスペースは新しいルールのために ScheduledQueryRules API を使用しています。 この記事では、従来のログ検索アラート ルール管理を従来の API から最新の API に切り替えるメリットと手順について説明します。

メリット

  • 1 つの API ですべてのログ検索アラート ルールを管理します。
  • アラート ルールを作成するための単一のテンプレート (以前は 3 つの個別のテンプレートが必要)。
  • すべての Azure リソース ログ アラート用の単一 API。
  • ステートフルな (プレビュー) 1 分間のログ検索アラートをサポートします。
  • 切り替え先ルールのために、PowerShell コマンドレットと Azure CLI をサポート。
  • 他のすべての種類のアラートおよび新しいルールへの重大度のアラインメント。
  • ルールの切り替えのために、Log Analytics ワークスペースや Application Insights リソースなどの複数の外部リソースにまたがるクロス ワークスペース ログ アラートを作成可能。
  • ユーザーはディメンションを指定して、切り替え先ルールに関するアラートを分割可能。
  • 切り替えられたルールに関し、ログ検索アラートではデータの期間を最大 2 日間に拡張しました (以前は 1 日に制限されていました)。

影響

  • 切り替え先ルールは、すべて現在の API を使用して作成/編集する必要があります。 Azure リソース テンプレートによるサンプルの使用および PowerShell によるサンプルの使用に関するページを参照してください。
  • 最新の API 内でルールが Azure Resource Manager 追跡対象リソースになり、一意である必要があるため、ルールのリソース ID が <WorkspaceName>|<savedSearchId>|<scheduleId>|<ActionId> の構造に変更されます。 アラート ルールの表示名は変更されません。

Process

この Azure Resource Graph Explorer クエリを使って、アップグレードするワークスペースを表示します。 リンクを開き、使用できるすべてのサブスクリプションを選んで、クエリを実行します。

切り替え手順は対話型ではなく、ほとんどの場合、手動の手順は必要ありません。 アラート ルールは、切り替え中または切り替え後に停止またはストールすることはありません。 各 Log Analytics ワークスペースに関連付けられているすべてのアラート ルールを切り替えるには、この呼び出しを実行します。

PUT /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview

次の JSON を含む要求本文がある場合:

{
    "scheduledQueryRulesEnabled" : true
}

次に、上記の API 呼び出しの呼び出しを簡略化するオープンソースのコマンドライン ツールである ARMClient を使用する例を示します。

$switchJSON = '{"scheduledQueryRulesEnabled": true}'
armclient PUT /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview $switchJSON

Azure CLI ツールを使用することもできます。

az rest --method put --url /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview --body "{\"scheduledQueryRulesEnabled\" : true}"

切り替えが成功した場合、応答は次のようになります。

{
    "version": 2,
    "scheduledQueryRulesEnabled" : true
}

ワークスペースの切り替え状態を確認する

この API 呼び出しを使用して、切り替えの状態を確認することもできます。

GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview

ARMClient ツールを使用することもできます。

armclient GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview

Azure CLI ツールを使用することもできます。

az rest --method get --url /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview

Log Analytics ワークスペースが scheduledQueryRules API に切り替えられると、応答は次のようになります。

{
    "version": 2,
    "scheduledQueryRulesEnabled" : true
}

Log Analytics ワークスペースが切り替えられなかった場合、応答は次のようになります。

{
    "version": 2,
    "scheduledQueryRulesEnabled" : false
}

次のステップ