Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Databricks CLI 内の alerts-v2 コマンド グループを使用すると、SQL アラートを管理できます。 アラートは定期的にクエリを実行し、その結果の条件を評価し、条件が満たされた場合は 1 人以上のユーザーや通知先に通知します。
databricks alerts-v2 create-alert
アラートを作成します。
databricks alerts-v2 create-alert DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]
Arguments
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 として実行します。
Examples
次の例では、JSON ファイルを使用してアラートを作成します。
databricks alerts-v2 create-alert "High CPU Alert" "SELECT cpu_usage FROM metrics" "abc123" @evaluation.json @schedule.json --json @alert.json
databricks alerts-v2 get-alert
アラートを取得します。
databricks alerts-v2 get-alert ID [flags]
Arguments
ID
取得するアラートの UUID。
オプション
Examples
次の例では、ID によってアラートを取得します。
databricks alerts-v2 get-alert 12345678-1234-1234-1234-123456789012
databricks alerts-v2 list-alerts
アラートを一覧表示します。 作成時刻順にユーザーがアクセスできるアラートの一覧を取得します。
databricks alerts-v2 list-alerts [flags]
Arguments
なし
オプション
--page-size int
返されるアラートの最大数。
--page-token string
前のリスト呼び出しから次のページを取得するためのページ トークン。
Examples
次の例では、アクセス可能なすべてのアラートを一覧表示します。
databricks alerts-v2 list-alerts
databricks alerts-v2 trash-alert
アラートを削除します。 アラートをごみ箱に移動します。 ごみ箱に入ったアラートはリスト ビューからすぐに消え、トリガーできなくなります。 UI を使用して、ゴミ箱にあるアラートを復元できます。 ごみ箱にあるアラートは、30 日後に完全に削除されます。
databricks alerts-v2 trash-alert ID [flags]
Arguments
ID
ごみ箱へのアラートの UUID。
オプション
--purge
アラートを完全に削除するかどうか。
Examples
次の例では、アラートをごみ箱に入れます。
databricks alerts-v2 trash-alert 12345678-1234-1234-1234-123456789012
次の例では、アラートを完全に削除します。
databricks alerts-v2 trash-alert 12345678-1234-1234-1234-123456789012 --purge
databricks alerts-v2 update-alert
アラートを更新します。
databricks alerts-v2 update-alert ID UPDATE_MASK DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]
Arguments
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 として実行します。
Examples
次の例では、アラートの表示名を更新します。
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 文字列
出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。
--log-format 形式
ログ形式の種類、 text 、または json。 既定値は text です。
--log-level 文字列
ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。
-o, --output 型
コマンド出力の種類( text または json)。 既定値は text です。
-p, --profile 文字列
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format 形式
進行状況ログを表示する形式: default、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット