sandbox コマンド グループ

Note

Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。

sandbox 内の コマンド グループは、Databricks サンドボックス環境の作成、構成、アクセスに役立ちます。

Important

Databricks サンドボックスは ベータ版です。

Databricks サンドボックス環境は、microVM 分離によってサポートされる SSH アクセス可能な開発環境です。 各サンドボックスは、プレインストールされたツール (Python、Node.js、Rust、Databricks CLI) と永続的ストレージを備えた個人用環境です。

作業を開始するには:

databricks auth login --host https://...
databricks sandbox register
databricks sandbox create
databricks sandbox ssh

databricks サンドボックスの構成

サンドボックスの名前と自動停止ポリシーを構成します。

--name、--idle-timeout、および--no-autostopの設定は独立しており、任意の組み合わせを渡すことができます。

databricks sandbox config <sandbox-id> [flags]

引数

<sandbox-id>

    構成するサンドボックスの ID。

オプション

--name string

    サンドボックスのラベル (最大 256 バイト)。 クリアするには、 --name= を渡します。

--idle-timeout string

    アイドル タイムアウト期間。 この値を 0 (または 0s) に設定してクリアし、マネージャーの既定値 (10m) を使用します。 有効な範囲: 1mに24hします。

--no-autostop

    true の場合、このサンドボックスはアイドル状態で自動的に停止することはありません。 戻す --no-autostop=false を渡します。

グローバル フラグ

Examples

databricks sandbox config my-sandbox-1234 --name my-project
databricks sandbox config my-sandbox-1234 --idle-timeout 15m
databricks sandbox config my-sandbox-1234 --idle-timeout 1h30m
databricks sandbox config my-sandbox-1234 --idle-timeout 0
databricks sandbox config my-sandbox-1234 --no-autostop
databricks sandbox config my-sandbox-1234 --no-autostop=false
databricks sandbox config my-sandbox-1234 --idle-timeout 30m --no-autostop=false

databricks サンドボックスの作成

新しいサンドボックス環境を作成します。

microVM によってサポートされる個人用開発環境を作成し、サンドボックスが実行されるまでブロックし、サンドボックス ID を出力します。

databricks sandbox create [flags]

オプション

--json

    JSON 形式で結果を返します。

--name string

    サンドボックスのラベル (最大 256 バイト)。

グローバル フラグ

Examples

databricks sandbox create
databricks sandbox create --name my-project
databricks sandbox create --json

databricks サンドボックスの既定値

databricks sandbox sshで使用される既定のサンドボックスを設定します。

既定値は、プロファイルごとに ~/.databricks/sandbox.json にローカルに格納されます。 サンドボックス ID は、書き込まれる前にサーバーに対して検証されます。

databricks sandbox default <sandbox-id> [flags]

エイリアス: set-default

引数

<sandbox-id>

    既定として設定するサンドボックス ID。

オプション

グローバル フラグ

Example

databricks sandbox default my-sandbox-1234

databricks サンドボックスの削除

サンドボックス環境を削除します。

これにより、指定したサンドボックスが完全に終了して削除されます。 コマンドは対話形式で確認を求めます。 --auto-approve を使用してプロンプトをスキップします。

databricks sandbox delete <sandbox-id> [flags]

引数

<sandbox-id>

    削除するサンドボックス ID。

オプション

--auto-approve

    対話型の確認プロンプトをスキップします。

グローバル フラグ

Examples

databricks sandbox delete my-sandbox-1234
databricks sandbox delete my-sandbox-1234 --auto-approve

databricks サンドボックス リスト

サンドボックス環境を一覧表示します。

現在の状態と ID を含め、アカウントに関連付けられているすべてのサンドボックスを表示します。

databricks sandbox list [flags]

オプション

--json

    JSON 形式で結果を返します。

グローバル フラグ

Examples

databricks sandbox list
databricks sandbox list --json

databricks サンドボックス レジスタ

サンドボックス用の専用 SSH キーを生成し、サービスに登録します。

このコマンド:

  1. ~/.ssh/sandbox_ed25519で Ed25519 SSH キーを生成します (存在しない場合)。
  2. 公開キーをサンドボックス サービスに登録し、 --nameでラベル付けします。
  3. 必要に応じて、~/.ssh/config エントリを使用してHost sandbox-gwを更新します。

登録後、 databricks sandbox ssh はこのキーを自動的に使用します。

databricks sandbox register [flags]

オプション

--name string

    登録済みキーのラベル (既定では、このマシンのホスト名)。 ラベルなしで登録する --name= を渡します。

グローバル フラグ

Examples

databricks sandbox register
databricks sandbox register --name my-laptop

databricks サンドボックス ssh

既定または特定のサンドボックス環境に SSH 接続します。 --後の追加の引数は、sshに直接渡されます。

databricks sandbox ssh [sandbox-id] [-- <ssh-args-or-command>...] [flags]

引数

[sandbox-id]

    オプションのサンドボックス ID。 省略した場合は、既定のサンドボックスを使用します。

オプション

--gateway string

    サンドボックス ゲートウェイのホスト名 (空の場合はプロファイルから自動検出されます)。

--port string

    サンドボックス ゲートウェイの SSH ポート。 既定値: 2222。

グローバル フラグ

Examples

databricks sandbox ssh
databricks sandbox ssh my-sandbox-1234
databricks sandbox ssh -- ls -la /home
databricks sandbox ssh my-sandbox-1234 -- cat /etc/os-release
databricks sandbox ssh -- -L 8080:localhost:8080

databricks サンドボックス ssh-key

サンドボックス サービスに登録されている SSH キーを管理します。

databricks sandbox ssh-key [command]

使用可能なコマンド

オプション

グローバル フラグ

databricks サンドボックス ssh-key list

サンドボックス サービスに登録されている SSH キーを一覧表示します。

各行には、サーバー割り当てキー ハッシュ (キーの削除に使用)、ユーザー指定の名前、および作成タイムスタンプと最終使用タイムスタンプが表示されます。 ( databricks sandbox register から) ローカルに登録されたキーは、ハッシュが一覧表示されているエントリのいずれかに一致するとマークされます。

databricks sandbox ssh-key list [flags]

オプション

--json

    JSON 形式で結果を返します。

グローバル フラグ

Examples

databricks sandbox ssh-key list
databricks sandbox ssh-key list --json

databricks サンドボックス ssh-key delete

サンドボックス サービスに登録されている SSH キーを削除します。

キー ハッシュは、 databricks sandbox ssh-key listによって返される識別子です。 削除後、対応する秘密キーを使用する SSH の試行は、キーを再登録するまで成功しません。

databricks sandbox ssh-key delete <key-hash> [flags]

引数

<key-hash>

    削除するキー ハッシュ。

オプション

グローバル フラグ

Example

databricks sandbox ssh-key delete a1b2c3d4e5f6...

databricks サンドボックスの開始

停止したサンドボックス環境を有効にします。

バッキング microVM を起動し、サンドボックスが実行中 (または最大 10 分) になるまでブロックします。 既に実行中のサンドボックスでこのコマンドを実行することは、no-opです。

databricks sandbox start <sandbox-id> [flags]

引数

<sandbox-id>

    有効にするサンドボックス ID。

オプション

グローバル フラグ

Example

databricks sandbox start my-sandbox-1234

databricks サンドボックスの状態

サンドボックス環境の詳細な状態を表示します。

databricks sandbox status <sandbox-id> [flags]

引数

<sandbox-id>

    検査するサンドボックス ID。

オプション

--json

    JSON 形式で結果を返します。

グローバル フラグ

Examples

databricks sandbox status my-sandbox-1234
databricks sandbox status my-sandbox-1234 --json

databricks サンドボックスの停止

実行中のサンドボックス環境を停止します。

バッキング microVM を終了しますが、サンドボックス レコードとその永続ストレージは保持されます。 既に停止しているサンドボックスを停止することは、no-opです。

databricks sandbox stop <sandbox-id> [flags]

引数

<sandbox-id>

    停止するサンドボックス ID。

オプション

グローバル フラグ

Example

databricks sandbox stop my-sandbox-1234

グローバル フラグ

--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 文字列

    該当する場合は、使用するバンドル ターゲット