注释
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明,包括任何数据使用规定。
sandbox
Databricks CLI 中的命令组可帮助你创建、配置和访问 Databricks 沙盒环境。
重要
Databricks 沙盒处于 Beta 阶段。
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]
Arguments
<sandbox-id>
要配置的沙盒的 ID。
选项
--name string
沙盒标签(最大 256 字节)。 传递给 --name= 清除。
--idle-timeout string
空闲超时持续时间。 将此值设置为 0 (或 0s) 以清除该值并使用管理器默认值 (10m)。 有效范围: 1m 到 24h.
--no-autostop
如果为 true,此沙盒永远不会在空闲时自动停止。 传递给 --no-autostop=false 还原。
示例
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 字节)。
示例
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
Arguments
<sandbox-id>
要设置为默认值的沙盒 ID。
选项
示例
databricks sandbox default my-sandbox-1234
databricks 沙盒删除
删除沙盒环境。
这会永久终止并删除指定的沙盒。 命令提示符以交互方式进行确认;用于 --auto-approve 跳过提示。
databricks sandbox delete <sandbox-id> [flags]
Arguments
<sandbox-id>
要删除的沙盒 ID。
选项
--auto-approve
跳过交互式确认提示。
示例
databricks sandbox delete my-sandbox-1234
databricks sandbox delete my-sandbox-1234 --auto-approve
databricks 沙盒列表
列出沙盒环境。
显示与帐户关联的所有沙盒,包括其当前状态和 ID。
databricks sandbox list [flags]
选项
--json
以 JSON 格式返回结果。
示例
databricks sandbox list
databricks sandbox list --json
databricks 沙盒注册
为沙盒生成专用 SSH 密钥,并将其注册到服务。
此命令:
- 生成 Ed25519 SSH 密钥(
~/.ssh/sandbox_ed25519如果不存在)。 - 将公钥注册到标记为
--name“沙盒”服务的公钥。 - (可选)使用
~/.ssh/config条目进行更新Host sandbox-gw。
注册后, databricks sandbox ssh 自动使用此密钥。
databricks sandbox register [flags]
选项
--name string
已注册密钥的标签(默认为此计算机的主机名)。 传递给 --name= 不带标签的注册。
示例
databricks sandbox register
databricks sandbox register --name my-laptop
databricks 沙盒 ssh
通过 SSH 连接到默认或特定的沙盒环境。 直接--传递给后ssh的额外参数。
databricks sandbox ssh [sandbox-id] [-- <ssh-args-or-command>...] [flags]
Arguments
[sandbox-id]
可选沙盒 ID。 如果省略,请使用默认沙盒。
选项
--gateway string
沙盒网关主机名(如果为空)从配置文件中自动检测。
--port string
沙盒网关 SSH 端口。 默认值:2222。
示例
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 sandbox ssh-key list- 列出向沙盒服务注册的 SSH 密钥。 -
databricks sandbox ssh-key delete- 删除向沙盒服务注册的 SSH 密钥。
选项
databricks 沙盒 ssh 密钥列表
列出向沙盒服务注册的 SSH 密钥。
每行显示服务器分配的密钥哈希(用于删除密钥)、用户提供的名称,以及创建和上次使用时间戳。 当本地注册的密钥 (from databricks sandbox register) 与列出的条目之一匹配时,将标记其哈希。
databricks sandbox ssh-key list [flags]
选项
--json
以 JSON 格式返回结果。
示例
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]
Arguments
<key-hash>
要删除的密钥哈希。
选项
示例
databricks sandbox ssh-key delete a1b2c3d4e5f6...
databricks 沙盒启动
打开已停止的沙盒环境。
启动后盾 microVM 并阻止,直到沙盒到达“正在运行”(或最多 10 分钟)。 在正在运行的沙盒上运行此命令是 no-op。
databricks sandbox start <sandbox-id> [flags]
Arguments
<sandbox-id>
要打开的沙盒 ID。
选项
示例
databricks sandbox start my-sandbox-1234
databricks 沙盒状态
显示沙盒环境的详细状态。
databricks sandbox status <sandbox-id> [flags]
Arguments
<sandbox-id>
要检查的沙盒 ID。
选项
--json
以 JSON 格式返回结果。
示例
databricks sandbox status my-sandbox-1234
databricks sandbox status my-sandbox-1234 --json
databricks 沙盒停止
停止正在运行的沙盒环境。
终止支持 microVM,但保留沙盒记录及其持久性存储。 停止已停止的沙盒是 no-op。
databricks sandbox stop <sandbox-id> [flags]
Arguments
<sandbox-id>
要停止的沙盒 ID。
选项
示例
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 字符串
如果适用,要使用的捆绑包目标