現在のログ アラート API にレガシ Log Analytics アラート API からアップグレードする

注意

この記事は、Azure パブリック (Azure Government または Azure China クラウドには関係 しません) にのみ関係します。

注意

ユーザーが、基本設定を現在の scheduledQueryRules API に切り替える選択をした後は、古い従来の Log Analytics アラート API の使用に戻すことはできません。

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

メリット

  • アラート ルールを作成するための単一のテンプレート (以前は 3 つの個別のテンプレートが必要)。
  • Log Analytics ワークスペースまたは Application Insights リソースの両方に対する単一の API。
  • PowerShell コマンドレット サポート
  • 他のすべてのアラートの種類に対する重大度の調整。
  • Log Analytics ワークスペースや Application Insights リソースなどの複数の外部リソースにまたがるクロス ワークスペース ログ アラートの作成機能。
  • ユーザーは、[集計] パラメーターを使用して、アラートを分割するディメンションを指定できます。
  • ログ アラートの期間は、最大 2 日間のデータに拡張されました (以前は 1 日に制限)。

影響

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

Process

切り替え手順は対話型ではなく、ほとんどの場合、手動の手順は必要ありません。 アラート ルールは、切り替え中または切り替え後に停止またはストールすることはありません。 この呼び出しを実行して、特定の 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

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

{
    "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

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

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

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

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

次のステップ