alerts-v2コマンドグループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI はパブリックプレビュー版です。
Databricks CLI使用には、使用状況データ プロビジョニングを含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。
Databricks CLI内のalerts-v2コマンドグループを使用すると、SQL アラートを管理できます。アラートは定期的にクエリを実行し、その結果の条件を評価し、条件が満たされた場合は1人以上のユーザーおよび/または通知先に通知します。
databricks アラート-v2 create-アラート
アラートを作成する。
databricks alerts-v2 create-alert DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]
議論
DISPLAY_NAME
アラートの表示名。
QUERY_TEXT
実行するクエリのテキスト。
WAREHOUSE_ID
アラートに添付されているSQLウェアハウスのID。
EVALUATION
アラートの評価条件。
SCHEDULE
アラートクエリを実行するスケジュール。
オプション
--custom-description string
アラートのカスタム説明。
--custom-summary string
アラートのカスタムサマリー。
--json JSON
インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。
--parent-path string
アラートを含むフォルダーのワークスペースパス。
--run-as-user-name string
サービスプリンシパルのユーザー名またはアプリケーションIDとして実行されます。
例
次の例は、JSONファイルを使用してアラートを作成する方法です。
databricks alerts-v2 create-alert "High CPU Alert" "SELECT cpu_usage FROM metrics" "abc123" @evaluation.json @schedule.json --json @alert.json
databricks アラート-v2 get-アラート
アラートを受け取る。
databricks alerts-v2 get-alert ID [flags]
議論
ID
取得するアラートのUUID。
オプション
例
次の例では、IDによってアラートを取得します。
databricks alerts-v2 get-alert 12345678-1234-1234-1234-123456789012
databricks アラート-v2 リスト-アラート
アラート一覧を表示する。ユーザーがアクセスできるアラートの一覧を、作成日時順に取得します。
databricks alerts-v2 list-alerts [flags]
議論
なし
オプション
--page-size int
返されるアラートの最大数。
--page-token string
前回のリスト呼び出しで取得したページトークンを使用して、次のページを取得します。
例
以下の例は、アクセス可能なすべてのアラートを一覧表示したものです。
databricks alerts-v2 list-alerts
databricks アラート-v2 ゴミ箱-アラート
アラートを削除します。アラートをゴミ箱に移動します。ゴミ箱に入れられたアラートはリストビューから即座に消え、二度とトリガーされなくなります。削除されたアラートは、UIから復元できます。ゴミ箱に入れられたアラートは、30日後に完全に削除されます。
databricks alerts-v2 trash-alert ID [flags]
議論
ID
ゴミ箱に移動されたアラートのUUID。
オプション
--purge
アラートを完全に削除するかどうか。
例
次の例は、アラートを削除する例です。
databricks alerts-v2 trash-alert 12345678-1234-1234-1234-123456789012
次の例は、アラートを完全に削除する方法です。
databricks alerts-v2 trash-alert 12345678-1234-1234-1234-123456789012 --purge
databricks アラート-v2 更新-アラート
アラートを更新する。
databricks alerts-v2 update-alert ID UPDATE_MASK DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]
議論
ID
アラートを識別するUUID。
UPDATE_MASK
更新するフィールドを指定するフィールドマスク。フィールド名はカンマで区切ってください。すべてのフィールドを更新するには、 *を使用してください。
DISPLAY_NAME
アラートの表示名。
QUERY_TEXT
実行するクエリのテキスト。
WAREHOUSE_ID
アラートに添付されているSQLウェアハウスのID。
EVALUATION
アラートの評価条件。
SCHEDULE
アラートクエリを実行するスケジュール。
オプション
--custom-description string
アラートのカスタム説明。
--custom-summary string
アラートのカスタムサマリー。
--json JSON
インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。
--parent-path string
アラートを含むフォルダーのワークスペースパス。
--run-as-user-name string
サービスプリンシパルのユーザー名またはアプリケーションIDとして実行されます。
例
次の例は、アラートの表示名を更新するものです。
databricks alerts-v2 update-alert 12345678-1234-1234-1234-123456789012 display_name "Updated Alert Name" "SELECT cpu_usage FROM metrics" "abc123" @evaluation.json @schedule.json
世界の国旗
--debug
デバッグログを有効にするかどうか。
-h または --help
Databricks CLI、関連するコマンドグループ、または関連するコマンドのヘルプを表示します。
--log-file string
出力ログを書き込むファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログは標準エラー出力に書き込まれます。
--log-format format
ログフォーマットタイプ、 textまたはjson 。デフォルト値はtextです。
--log-level string
ログフォーマットレベルを表す文字列。指定されていない場合、ログフォーマットレベルは無効になります。
-o, --output タイプ
コマンド出力タイプ、 textまたはjson 。デフォルト値はtextです。
-p, --profile string
コマンドを実行するために使用する、 ~/.databrickscfgファイル内のプロファイル名。このフラグが指定されていない場合、存在する場合はDEFAULTという名前のプロファイルが使用されます。
--progress-format format
進捗ログを表示する形式: default 、 append 、 inplace 、または json
-t, --target string
該当する場合、使用するバンドルターゲット