Databricks CLI 的組態設定檔

注意

Databricks CLI 的使用受 Databricks 授權Databricks 隱私權聲明約束,包括任何使用資料條款。

本文說明如何使用 Databricks CLI 搭配配置文件。 它假設您已經安裝 Databricks CLI,並建立 Databricks 組態配置檔檔案。 請參閱 安裝或更新 Databricks CLIAzure 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 上的 ~(使用者主資料夾)資料夾中,或在 Windows 上的 %USERPROFILE%(使用者主資料夾)資料夾中尋找 .databrickscfg 檔案。 若要變更 .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