通过

configure 命令组

  • 项目

注意

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

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

使用 Databricks CLI 中的 configure 命令组，可以使用 Azure Databricks 个人访问令牌或 Microsoft Entra ID（以前称为 Azure Active Directory）令牌通过 Azure Databricks 对 Databricks CLI 进行身份验证。

注意

作为安全最佳做法，在使用自动化工具、系统、脚本和应用进行身份验证时，Databricks 建议使用属于服务主体（而不是工作区用户）的个人访问令牌。 若要为服务主体创建令牌，请参阅管理服务主体的令牌。

请注意，本文仅介绍用于启用工作区级命令调用的 Azure Databricks 个人访问令牌和 Microsoft Entra ID 令牌身份验证。 有关其他身份验证配置选项，请参阅为 Databricks CLI 设置身份验证。

重要

在运行此命令之前，请务必设置 Databricks CLI。

可以通过将 configure 命令追加到 databricks configure 中来运行这些命令。 若要显示 configure 命令的帮助，请运行 databricks configure -h。

创建配置文件

配置文件是一个设置集合，其中包含 Azure Databricks 工作区 URL 和访问令牌值等身份验证信息。 配置文件具有编程名称，例如 DEFAULT、DEV 或 PROD。

若要创建配置文件，请运行 configure 命令，如下所示：

databricks configure --host <workspace-url>

对于 <workspace-url>，请以 https://adb-<workspace-id>.<random-number>.databricks.azure.cn 格式输入每工作区 URL。 若要获取每工作区 URL，请参阅每工作区 URL。

该命令会提示你输入映射到指定 <workspace-url> 的 Azure Databricks 个人访问令牌或 Microsoft Entra ID（以前称为 Azure Active Directory）令牌：

✔ Databricks Token:

输入访问令牌后，该访问令牌默认会存储在 Linux 或 macOS 上的 ~/.databrickscfg 文件中，或 Windows 上的 %USERPROFILE%\.databrickscfg 文件中。 该文件包含名为 DEFAULT 的默认连接配置文件条目：

[DEFAULT]
host  = <workspace-url>
token = <access-token>

若要为连接配置文件使用其他名称而不是 DEFAULT，请将 --profile 选项添加到 configure 命令，例如：

databricks configure --host <workspace-url> --profile <profile-name>

提示

可以在 --profile 或 -p 之后按 Tab 以显示可供选择的现有可用配置文件的列表，而不是手动输入配置文件名称。

指定的连接配置文件中的所有现有主机和令牌信息将由新的主机和令牌信息覆盖。

通过将多个连接配置文件添加到 .databrickscfg 文件，你可以通过在命令的 --profile 选项中指定目标连接配置文件的名称在不同的工作区中快速运行命令。 如果你不在支持 --profile 选项的命令中指定该选项，该命令默认将使用 DEFAULT 连接配置文件。

例如，你有一个名为 DEV 的连接配置文件引用用于开发工作负载的 Azure Databricks 工作区，以及一个名为 PROD 的独立连接配置文件，该连接配置文件引用用于生产工作负载的不同 Azure Databricks 工作区。

可以通过设置环境变量 DATABRICKS_CONFIG_FILE 来更改此 .databrickscfg 文件的默认路径。 若要了解如何设置环境变量，请参阅操作系统的文档。

若要获取有关现有配置文件的信息，请使用 auth 命令组。