Databricks CLI 的配置文件

本文介绍如何在 Databricks CLI 与 Azure Databricks 帐户和工作区之间设置身份验证。 请参阅什么是 Databricks CLI？。

本文假定你已安装 Databricks CLI 并设置 CLI 身份验证。 请参阅：

• 安装或更新 Databricks CLI
• Databricks CLI 身份验证

获取有关配置文件的信息

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

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

默认情况下，Databricks CLI 在 Unix、Linux 或 macOS 上的 ~（用户主目录）文件夹中或者在 Windows 上的 %USERPROFILE%（用户主目录）文件夹中查找 .databrickscfg 文件。 可以通过设置环境变量 DATABRICKS_CONFIG_FILE 来更改 .databrickscfg 文件的默认路径。 若要了解如何设置环境变量，请参阅操作系统的文档。

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

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

# Or:
databricks auth env --host <account-console-url>

# Or:
databricks auth env --host <workspace-url>

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

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "<configuration-profile-name>",
    "DATABRICKS_HOST": "<workspace-url>",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

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

databricks auth profiles

输出（为简洁起见，使用省略号来代表省略的内容）：

{
  "profiles": [
    {
      "name": "<configuration-profile-name>",
      "host": "<workspace-url>",
      "cloud": "<cloud-id>",
      "auth_type": "<auth-type>",
      "valid": true
    },
    {
      "...": "..."
    }
  ]
}

auth profiles 命令的输出不显示任何访问令牌。 若要显示访问令牌，请运行上述 auth env 命令。

测试默认配置文件设置

若要检查是否正确设置了身份验证，可运行如下所示的命令，该命令会列出与 DEFAULT 配置文件关联的 Azure Databricks 工作区的可用 Databricks Runtime 版本。

以下调用假设你未设置任何特殊环境变量，这些环境变量优先于 DEFAULT 配置文件中的设置。 有关详细信息，请参阅身份验证评估顺序。

databricks clusters spark-versions

测试配置文件

若要检查是否正确设置了任何配置文件，可以结合某个工作区级配置文件名称运行如下所示的命令。 此命令列出与指定的配置文件（此处用占位符 <configuration-profile-name> 表示）关联的 Azure Databricks 工作区的可用 Databricks Runtime 版本：

databricks clusters spark-versions -p <configuration-profile-name>

若要列出特定配置文件的详细信息，请运行以下命令：

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

若要列出所有可用配置文件的详细信息，请运行以下命令：

databricks auth profiles