environments 命令组

Note

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。

Databricks CLI 的使用须遵守 Databricks 许可Databricks 隐私声明,包括任何数据使用规定。

Databricksenvironments CLI 中的命令组允许管理环境资源。 环境 API 为不同类型的环境提供管理功能,包括用于定义要在无服务器笔记本和作业中使用的环境版本和依赖项的工作区级基础环境。

databricks 环境 create-workspace-base-environment

创建新的工作区基础环境。 这是一个长时间运行的操作,异步生成具体化环境以优化依赖项解析。

databricks environments create-workspace-base-environment DISPLAY_NAME [flags]

参数

DISPLAY_NAME

    工作区基础环境的可读显示名称。

选项

--base-environment-type BaseEnvironmentType

    基本环境(CPU 或 GPU)的类型。 支持的值:CPUGPU

--filepath string

    环境 YAML 文件的工作区文件或 Unity 目录卷路径。

--json JSON

    内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。

--name string

    工作区基础环境的资源名称。

--no-wait

    不要等待到达 DONE 状态。

--request-id string

    此请求的唯一标识符。

--timeout duration

    达到 DONE 状态的最长时间。

--workspace-base-environment-id string

    要用于工作区基础环境的 ID,该 ID 将成为资源名称的最终组件。

全局标志

Examples

以下示例创建 CPU 工作区基础环境:

databricks environments create-workspace-base-environment "My Python Env" --base-environment-type CPU --filepath /Workspace/environments/env.yaml

databricks 环境 delete-workspace-base-environment

删除工作区基础环境。 删除基础环境可能会影响链接的笔记本和作业。 此操作不可逆。

databricks environments delete-workspace-base-environment NAME [flags]

参数

NAME

    必填。 要删除的工作区基础环境的资源名称。 格式:workspace-base-environments/{workspace_base_environment}

选项

全局标志

Examples

以下示例删除工作区基础环境:

databricks environments delete-workspace-base-environment workspace-base-environments/my-env-id

databricks 环境 get-default-workspace-base-environment

获取默认工作区基础环境配置。 返回 CPU 和 GPU 计算的当前默认基本环境设置。

databricks environments get-default-workspace-base-environment NAME [flags]

参数

NAME

    默认工作区基础环境的静态资源名称。 格式:default-workspace-base-environment

选项

全局标志

Examples

以下示例获取默认工作区基础环境:

databricks environments get-default-workspace-base-environment default-workspace-base-environment

databricks 环境 get-operation

获取长时间运行的操作的状态。 客户端可以使用此方法轮询操作结果。

databricks environments get-operation NAME [flags]

参数

NAME

    作资源的名称。

选项

全局标志

Examples

以下示例获取长时间运行的操作的状态:

databricks environments get-operation operations/1234567890

databricks 环境 get-workspace-base-environment

按其名称获取工作区基础环境。

databricks environments get-workspace-base-environment NAME [flags]

参数

NAME

    必填。 要检索的工作区基础环境的资源名称。 格式:workspace-base-environments/{workspace_base_environment}

选项

全局标志

Examples

以下示例获取工作区基础环境:

databricks environments get-workspace-base-environment workspace-base-environments/my-env-id

databricks 环境 list-workspace-base-environments

列出工作区中的所有工作区基础环境。

databricks environments list-workspace-base-environments [flags]

参数

没有

选项

--page-size int

    每个页面要返回的最大环境数。

--page-token string

    分页的页令牌。

全局标志

Examples

以下示例列出了所有工作区基础环境:

databricks environments list-workspace-base-environments

databricks 环境 refresh-workspace-base-environment

刷新工作区基础环境的具体化环境。 这是一项长时间运行的操作,可异步重新生成具体化环境。 现有具体化环境在过期之前保持可用。

databricks environments refresh-workspace-base-environment NAME [flags]

参数

NAME

    必填。 要刷新的工作区基础环境的资源名称。 格式:workspace-base-environments/{workspace_base_environment}

选项

--no-wait

    不要等待到达 DONE 状态。

--timeout duration

    达到 DONE 状态的最长时间。

全局标志

Examples

以下示例刷新工作区基础环境:

databricks environments refresh-workspace-base-environment workspace-base-environments/my-env-id

databricks 环境 update-default-workspace-base-environment

更新默认工作区基础环境配置。 将指定的基本环境设置为 CPU 和/或 GPU 计算的工作区默认值。

databricks environments update-default-workspace-base-environment NAME UPDATE_MASK [flags]

参数

NAME

    此单一实例资源的资源名称。 格式:default-workspace-base-environment

UPDATE_MASK

    用于指定要更新的字段的字段掩码。 有效的字段路径: cpu_workspace_base_environmentgpu_workspace_base_environment。 用于 * 更新所有字段。

选项

--cpu-workspace-base-environment string

    CPU 计算的默认工作区基础环境。

--gpu-workspace-base-environment string

    GPU 计算的默认工作区基础环境。

--json JSON

    内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。

--name string

    此单一实例资源的资源名称。

全局标志

Examples

以下示例设置默认的 CPU 工作区基础环境:

databricks environments update-default-workspace-base-environment default-workspace-base-environment cpu_workspace_base_environment --cpu-workspace-base-environment workspace-base-environments/my-cpu-env

databricks 环境 update-workspace-base-environment

更新现有的工作区基础环境。 这是一项长时间运行的操作,可异步重新生成具体化环境。 现有具体化环境在过期之前保持可用。

databricks environments update-workspace-base-environment NAME DISPLAY_NAME [flags]

参数

NAME

    工作区基础环境的资源名称。 格式:workspace-base-environments/{workspace_base_environment}

DISPLAY_NAME

    工作区基础环境的可读显示名称。

选项

--base-environment-type BaseEnvironmentType

    基本环境(CPU 或 GPU)的类型。 支持的值:CPUGPU

--filepath string

    环境 YAML 文件的工作区文件或 Unity 目录卷路径。

--json JSON

    内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。

--name string

    工作区基础环境的资源名称。

--no-wait

    不要等待到达 DONE 状态。

--timeout duration

    达到 DONE 状态的最长时间。

全局标志

Examples

以下示例更新工作区基础环境:

databricks environments update-workspace-base-environment workspace-base-environments/my-env-id "Updated Python Env" --filepath /Workspace/environments/updated-env.yaml

全局标志

--debug

  是否启用调试日志记录。

-h--help

    显示 Databricks CLI、相关命令组或相关命令的帮助。

--log-file 字符串

    一个字符串,表示要将输出日志写入到的文件。 如果未指定此标志,则默认会将输出日志写入到 stderr。

--log-format 格式

    日志格式类型,textjson。 默认值为 text

--log-level 字符串

    一个表示日志格式级别的字符串。 如果未指定,则禁用日志格式级别。

-o, --output 类型

    命令输出类型为 textjson。 默认值为 text

-p, --profile 字符串

    要用于运行命令的 ~/.databrickscfg 文件中的配置文件名称。 如果未指定此标志,并且存在命名为 DEFAULT 的配置文件,则使用该配置文件。

--progress-format 格式

    显示进度日志的格式: defaultappendinplacejson

-t, --target 字符串

    如果适用,要使用的捆绑包目标