notification-destinations コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のnotification-destinationsコマンドグループには、ワークスペースの通知先を管理するコマンドが含まれています。通知先は、クエリ アラートとジョブの通知を Databricks の外部の宛先に送信するために使用されます。ワークスペース管理者のみが、通知先を作成、更新、削除できます。通知 先の管理を参照してください。
databricks notification-destinations create
通知先を作成します。ワークスペース管理者のアクセス許可が必要です。
databricks notification-destinations create [flags]
引数
なし
オプション
--display-name string
通知先の表示名。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path
例
次の例では、表示名を持つ通知先を作成します。
databricks notification-destinations create --display-name "Slack Alerts" --json '{"destination_type": "slack", "config": {"url": "https://hooks.slack.com/services/..."}}'
databricks notification-destinations delete
通知先を削除します。ワークスペース管理者のアクセス許可が必要です。
databricks notification-destinations delete ID [flags]
引数
ID
通知先を識別する UUID。
オプション
例
次の例では、通知先を削除します。
databricks notification-destinations delete 12345678-1234-1234-1234-123456789abc
databricks notification-destinations get
通知先を取得します。
databricks notification-destinations get ID [flags]
引数
ID
通知先を識別する UUID。
オプション
例
次の例では、通知先の詳細を取得します。
databricks notification-destinations get 12345678-1234-1234-1234-123456789abc
databricks notification-destinations list
通知先を一覧表示します。
databricks notification-destinations list [flags]
引数
なし
オプション
--page-size int
ページごとに返される結果の最大数。
--page-token string
前の呼び出しから受信したページ トークン。これを使用して、結果の次のページを取得します。
例
次の例は、すべての通知先をリストします。
databricks notification-destinations list
次の例は、ページネーションを含む通知先をリストします。
databricks notification-destinations list --page-size 50
databricks notification-destinations update
通知先を更新します。ワークスペース管理者のアクセス許可が必要です。要求本文には少なくとも 1 つのフィールドが必要です。
databricks notification-destinations update ID [flags]
引数
ID
通知先を識別する UUID。
オプション
--display-name string
通知先の表示名。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path
例
次の例では、通知先の表示名を更新します。
databricks notification-destinations update 12345678-1234-1234-1234-123456789abc --display-name "Updated Slack Alerts"
次の例では、通知先を JSON 構成で更新します。
databricks notification-destinations update 12345678-1234-1234-1234-123456789abc --json '{"display_name": "Production Alerts", "config": {"url": "https://hooks.slack.com/services/..."}}'
グローバルフラグ
--debug
デバッグログを有効にするかどうか。
-h または --help
Databricks CLI、関連するコマンド グループ、または関連するコマンドのヘルプを表示します。
--log-file string
出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。
--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
該当する場合は、使用するバンドル・ターゲット