共用方式為


configure 命令

Note

此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態

Databricks CLI 的使用受限於 Databricks 授權Databricks 隱私權聲明,包括任何使用數據條款。

configure Databricks CLI 中的指令允許你使用 Azure Databricks 個人存取權杖Microsoft Entra ID(前稱 Azure Active Directory)令牌來驗證 Databricks CLI。

Note

作為安全性最佳做法,當您使用自動化工具、系統、指令碼和應用程式進行驗證時,Databricks 建議您使用屬於服務主體的個人存取權杖,而不是工作區使用者。 若要建立服務主體的令牌,請參閱 管理服務主體的令牌

請注意,本文僅涵蓋 Azure Databricks 個人存取權杖及 Microsoft Entra ID 令牌認證,以啟用 工作區層級 指令的呼叫。 如需其他驗證組態選項,請參閱 Databricks CLI 的驗證。

Databricks 配置

在您的檔案中 ~/.databrickscfg 設定配置檔。 組態設定檔是一組設定,包含認證資訊,例如 Azure Databricks 工作區 URL 和存取權杖值。

組態設定檔具有程式設計名稱,例如 DEFAULTDEVPROD。 將多個配置檔新增至 .databrickscfg 檔案,可讓您在命令的 選項中指定目標連線配置檔的名稱,以快速跨各種工作區執行命令 --profile 。 如果您未在支援此選項的命令中指定 --profile 選項,則命令預設會使用 DEFAULT 連線配置檔。

例如,您可以有名為 DEV 的連接配置檔,其會參考您用於開發工作負載的 Azure Databricks 工作區,以及另一個名為 connection profile 的連線配置檔,該配置檔 PROD 會參考用於生產工作負載的不同 Azure Databricks 工作區。

若要取得現有組態配置檔的相關信息,請使用 auth 命令群組

您可以藉由設定環境變數 .databrickscfg來變更檔案的預設路徑DATABRICKS_CONFIG_FILE

如果在非互動式模式中叫用此命令,它會從 stdin 讀取令牌。 主機必須使用--host旗標或DATABRICKS_HOST環境變數來指定。

databricks configure [flags]

選項

--configure-cluster

    設定叢集的提示

--host string

    Databricks 工作區主機 URL

工作區主機 URL 是每個工作區的網址,格式為 https://adb-<workspace-id>.<random-number>.azuredatabricks.net。 若要取得個別工作區 URL,請參閱個別工作區 URL

--profile string

    要設定的連接配置檔名稱。 (預設「DEFAULT」)

全域旗標

Examples

以下範例設定預設設定檔的驗證:

databricks configure

下列範例會針對特定設定檔進行驗證設定:

databricks configure --profile my-profile

下列範例會設定特定主機的驗證:

databricks configure --host https://my-workspace.cloud.databricks.com

下列範例會使用叢集組態來設定驗證:

databricks configure --configure-cluster

全域旗標

--debug

  是否要啟用偵錯記錄。

-h--help

    顯示 Databricks CLI、相關命令群組或相關命令的幫助說明。

--log-file 字串

    字串,表示要寫入輸出記錄檔的檔案。 若未指定此旗標,則預設值是將輸出記錄寫入 stderr。

--log-format 格式

    記錄格式類型,textjson。 預設值是 text

--log-level 字串

    表示日誌格式層級的字串。 若未指定,則日誌的格式層級功能將被停用。

-o, --output 類型

    指令輸出類型,textjson。 預設值是 text

-p, --profile 字串

    用於執行命令的~/.databrickscfg檔案中的配置檔名稱。 如果未指定此旗標,則如果存在,則會使用名為 DEFAULT 的配置檔。

--progress-format 格式

    顯示進度記錄的格式:default、、appendinplace、 或json

-t, --target 字串

    如果適用,要使用的套件組合目標

建立組態配置檔

若要建立組態設定檔,請 configure 執行 命令:

databricks configure --host <workspace-url>

命令會提示您輸入 Azure Databricks 個人存取令牌Microsoft Entra ID(原稱 Azure Active Directory)令牌,以對應指定的<workspace-url>

✔ Databricks Token:

輸入存取令牌之後,存取令牌會儲存在 Linux 或 macOS 的檔案 ~/.databrickscfg 中,或 %USERPROFILE%\.databrickscfg 預設儲存在 Windows 上。 檔案包含名為 DEFAULT 的預設連線設定檔項目:

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

若要對連線設定檔使用不同的名稱而不是DEFAULT,請在--profile命令中新增configure選項,例如:

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

Tip

您可以在 Tab--profile 之後按 -p,以顯示現有可用組態配置檔的清單,以便從中選擇,而不是手動輸入組態配置檔名稱。

指定連接配置檔內的任何現有主機和令牌資訊,會以新的主機和令牌資訊覆寫。