メインコンテンツまでスキップ

sandbox コマンド・グループ

注記

Databricks CLI の使用には、Databricks ライセンスおよびDatabricks プライバシー通知(使用データ条項を含む)が適用されます。

Databricks CLI内のsandboxコマンド グループを使用すると、Databricksサンドボックス環境を作成、構成、アクセスできます。

Databricks サンドボックス環境は、マイクロVM分離を基盤とした、SSHでアクセス可能な開発環境です。各サンドボックスは、事前インストール済みのツール(Python、Node.js、Rust、およびDatabricks CLI)および永続ストレージ

利用を開始するには以下の手順を踏みます。

Bash
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)が使用されます。有効な範囲:1m24h

--no-autostop

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

グローバル フラグ

Bash
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バイト)

グローバル フラグ

Bash
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

オプション

グローバル フラグ

Bash
databricks sandbox default my-sandbox-1234

databricks サンドボックス delete

サンドボックス環境を削除してください。

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

databricks sandbox delete <sandbox-id> [flags]

引数

<sandbox-id>

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

オプション

--auto-approve

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

グローバル フラグ

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

databricks サンドボックス list

サンドボックス環境を一覧表示してください。

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

databricks sandbox list [flags]

オプション

--json

結果をJSON形式で返却してください。

グローバル フラグ

Bash
databricks sandbox list
databricks sandbox list --json

databricks サンドボックス 登録する

サンドボックス用の専用SSHキーを生成し、サービスに登録してください。

このコマンド:

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

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

databricks sandbox register [flags]

オプション

--name string

登録済みキーのラベル(このマシンのホスト名にデフォルト設定されます)。--name= を渡してラベルなしで登録する。

グローバル フラグ

Bash
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

グローバル フラグ

Bash
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 キー

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

databricks sandbox ssh-key [command]

使用可能なコマンド

オプション

グローバル フラグ

Databricks サンドボックス SSHキーリスト

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

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

databricks sandbox ssh-key list [flags]

オプション

--json

結果をJSON形式で返却してください。

グローバル フラグ

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

データブリックス サンドボックス SSHキーを削除する

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

キーハッシュとは、databricks sandbox ssh-key list から返される識別子です。削除すると、対応する秘密鍵を使用するSSH接続は、再度キーを登録するまでは成功しません。

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

引数

<key-hash>

削除するキーハッシュ。

オプション

グローバル フラグ

Bash
databricks sandbox ssh-key delete a1b2c3d4e5f6...

Databricks サンドボックスの起動

停止しているサンドボックス環境を起動してください。

バックエンドのmicroVMを起動し、サンドボックスが稼働状態になるまで(または最大10分間)ブロックします。既に実行中のサンドボックスでこのコマンドを実行しても、何もしません。

databricks sandbox start <sandbox-id> [flags]

引数

<sandbox-id>

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

オプション

グローバル フラグ

Bash
databricks sandbox start my-sandbox-1234

databricks サンドボックス status

サンドボックス環境の詳細ステータスを表示する。

databricks sandbox status <sandbox-id> [flags]

引数

<sandbox-id>

確認対象のサンドボックスID

オプション

--json

結果をJSON形式で返却してください。

グローバル フラグ

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

databricks サンドボックス stop

実行中のサンドボックス環境を停止してください。

バックアップマイクロVMは終了しますが、サンドボックスレコードと永続ストレージは保持されます。停止済みのサンドボックスを停止しても、処理は行われません。

databricks sandbox stop <sandbox-id> [flags]

引数

<sandbox-id>

停止対象のサンドボックスID。

オプション

グローバル フラグ

Bash
databricks sandbox stop my-sandbox-1234

グローバル フラグ

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

進行状況ログの表示形式: defaultappendinplace、または json

-t, --target string

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