Databricks CLI 的配置文件

注意

Databricks CLI 使用受 Databricks 许可证和 Databricks 隐私声明的约束，包括任何使用情况数据预配。

本文介绍如何将 Databricks CLI 与配置文件配合使用。 它假定你已安装 Databricks CLI 并创建了 Databricks 配置文件。 请参阅安装或更新 Databricks CLI 和 Azure Databricks 配置文件。

获取有关配置文件的信息

将多个配置文件添加到 .databrickscfg 文件后，您就可以通过在命令的 --profile 或 -p 参数中指定目标配置文件的名称，快速跨多个工作区运行命令。 如果未指定配置文件，CLI 会按以下顺序选择一个配置文件：

  1. 环境变量 DATABRICKS_CONFIG_PROFILE （如果已设置）。
  2. .databrickscfg 的 [__settings__] 部分中的 default_profile 设置（如果有的话）。 您可以使用 databricks auth switch 进行设置。 请参阅 databricks auth switch。
  3. DEFAULT 配置文件。

提示

可以在 Tab 或 --profile 之后按 -p 以显示可供选择的现有可用配置文件的列表。

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

默认情况下，Databricks CLI 在 Unix、Linux 或 macOS 上的 .databrickscfg（用户主目录）文件夹中或者在 Windows 上的 ~（用户主目录）文件夹中查找 %USERPROFILE% 文件。 要更改 .databrickscfg 文件的默认路径，将环境变量 DATABRICKS_CONFIG_FILE 设置为不同路径。 请参阅 .databrickscfg 特定字段。

若要获取有关现有配置文件的信息，请运行 auth describe 命令：

databricks auth describe --profile <configuration-profile-name>

例如，下面是已配置为使用 Azure Databricks 个人访问令牌进行身份验证的配置文件的输出：

Host: https://dbc-a1b2345c-d6e7.cloud.databricks.com
User: user@example.com
Authenticated with: pat
-----
Current configuration:
  ✓ host: https://dbc-a1b2345c-d6e7.cloud.databricks.com (from ~/.databrickscfg config file)
  ✓ token: ******** (from ~/.databrickscfg config file)
  ✓ profile: <configuration-profile-name> (from --profile flag)
  ✓ auth_type: pat

注意

auth env 命令已弃用。 使用 databricks auth describe 检查配置文件配置，或使用 databricks auth token 获取缓存的 OAuth 访问令牌。

若要获取有关所有可用配置文件的信息，请运行 auth profiles 命令：

databricks auth profiles

Name                     Host                                            Valid
DEFAULT                  https://dbc-a1b2345c-d6e7.cloud.databricks.com  YES
Development              https://dbc-a1b2345c-d6e7.cloud.databricks.com  YES
Staging                  https://dbc-a1b2345c-d6e7.cloud.databricks.com  YES
Production               https://dbc-a1b2345c-d6e7.cloud.databricks.com  YES

auth profiles 命令的输出不显示任何访问令牌。 若要显示特定配置文件的令牌详细信息，请运行 databricks auth describe --profile <profile-name> 或 databricks auth token --profile <profile-name>。

重要

Databricks CLI 不适用于 .netrc 文件。 你可能会在环境将一个 .netrc 文件用于其他目的，但 Databricks CLI 不会使用该 .netrc 文件。

测试你的配置文件

要测试您的配置文件并验证您是否正确设置了身份验证，请运行一个连接到工作区的命令。

如果未指定配置文件，则使用默认的配置文件。 例如，以下命令列出了与 DEFAULT 配置文件关联的 Azure Databricks 工作区的可用 Databricks Runtime 版本。

注意

此命令假定你没有设置任何其优先级高于 DEFAULT 配置文件中设置的环境变量。 有关详细信息，请参阅身份验证评估顺序。

databricks clusters spark-versions

若要验证特定的配置文件，请使用 -p 标志提供配置文件名称。

databricks clusters spark-versions -p PROD
  • Last updated on