此參考會列出 Databricks 統一驗證的環境變數和設定欄位。 它們在 Databricks CLI、Terraform 提供者和適用於 Python、Java 和 Go 的 SDK 中一致運作。
使用此參考來設定驗證或疑難排解驗證問題。 每個條目包括:
- 環境變數: 在您的 shell 環境中設定此設定。
-
.databrickscfg欄位: 在 配置描述檔中使用此選項。 - Terraform 欄位: 在您的 Terraform 提供者區塊中設定此設定。 請參閱 Databricks Terraform 提供者檔中的 驗證 。
-
Config欄位: 使用ConfigAPI。
一般組態欄位
這些變數會設定 Databricks 的基本連線和計算設定。
| 一般名稱 | Description | 環境變數 |
.databrickscfg 欄位、Terraform 欄位 |
Config 欄位 |
|---|---|---|---|---|
| Azure Databricks 主機 | (字串) Azure Databricks 工作區端點或 Azure Databricks 帳戶端點的 Azure Databricks 主機 URL 位址。 | DATABRICKS_HOST |
host |
host (Python)setHost(Java)Host (開始) |
| Azure Databricks 憑證 | (字串) Azure Databricks 個人存取權杖或 Microsoft Entra ID 權杖。 | DATABRICKS_TOKEN |
token |
token (Python)setToken(Java)Token (開始) |
| Azure Databricks 帳戶識別碼 | (字串) 用於 Azure Databricks 帳戶端點的 Azure Databricks 帳戶識別碼。 只有在 Azure Databricks 主機也設定為 https://accounts.azuredatabricks.net時才會生效。 |
DATABRICKS_ACCOUNT_ID |
account_id |
account_id (Python)setAccountID(Java)AccountID (開始) |
| 叢集識別碼 | (字串)要使用的叢集標識碼 | DATABRICKS_CLUSTER_ID |
cluster_id |
cluster_id |
| 無伺服器計算 | (字串)無伺服器計算自動啟用設定。 合法值為 auto。 |
DATABRICKS_SERVERLESS_COMPUTE_ID |
serverless_compute_id |
serverless_compute_id |
| 一般名稱 | Description | 環境變數 |
.databrickscfg 欄位、Terraform 欄位 |
Config 欄位 |
|---|---|---|---|---|
| Azure 用戶端識別碼 | (字串)Microsoft Entra ID 服務主體的應用程式識別碼。 與 Azure 受控識別驗證和 Microsoft Entra ID 應用程式識別驗證搭配使用。 | ARM_CLIENT_ID |
azure_client_id |
azure_client_id (Python)setAzureClientID(Java)AzureClientID (開始) |
| Azure 用戶端密碼 | (字串)Microsoft Entra ID 服務主體的客戶端密碼。 與 Microsoft Entra ID 服務主體驗證搭配使用。 | ARM_CLIENT_SECRET |
azure_client_secret |
azure_client_secret (Python)setAzureClientSecret(Java)AzureClientSecret (開始) |
| 用戶端識別碼 | (字串) Azure Databricks 受控服務主體或 Microsoft Entra ID 受控服務主體的用戶端識別碼。 與 OAuth M2M 驗證搭配使用。 | DATABRICKS_CLIENT_ID |
client_id |
client_id (Python)setClientId(Java)ClientId (開始) |
| 客戶端密碼 | (字串) Azure Databricks 受控服務主體或 Microsoft Entra ID 受控服務主體的用戶端密碼。 與 OAuth M2M 驗證搭配使用。 | DATABRICKS_CLIENT_SECRET |
client_secret |
client_secret (Python)setClientSecret(Java)ClientSecret (開始) |
| Azure 環境 | (字串) Azure 環境類型。 預設為 PUBLIC。 |
ARM_ENVIRONMENT |
azure_environment |
azure_environment (Python)setAzureEnvironment(Java)AzureEnvironment (開始) |
| Azure 租戶 ID | (字串)Microsoft Entra ID 服務主體的租戶ID。 | ARM_TENANT_ID |
azure_tenant_id |
azure_tenant_id (Python)setAzureTenantID(Java)AzureTenantID (開始) |
| Azure 使用 MSI | (布林值) True 表示對服務主體使用 Azure 受控服務識別無密碼驗證流程。 需要同時設定 Azure 資源識別碼。 | ARM_USE_MSI |
azure_use_msi |
AzureUseMSI (開始) |
| Azure 資源識別碼 | (字串) Azure Databricks 工作區的 Azure Resource Manager 識別碼。 | DATABRICKS_AZURE_RESOURCE_ID |
azure_workspace_resource_id |
azure_workspace_resource_id (Python)setAzureResourceID(Java)AzureResourceID (開始) |
.databrickscfg 特定欄位
使用這些環境變數或欄位為 .databrickscfg 指定非預設設定。 另請參閱 Azure Databricks 組態設定檔。
| 一般名稱 | Description | 環境變數 | Terraform 欄位 |
Config 欄位 |
|---|---|---|---|---|
.databrickscfg 檔案路徑 |
(字串)檔案的 .databrickscfg 非預設路徑。 |
DATABRICKS_CONFIG_FILE |
config_file |
config_file (Python)setConfigFile(Java)ConfigFile (開始) |
.databrickscfg 預設設定檔 |
(字串) 要使用的預設具名設定檔,而非 DEFAULT。 |
DATABRICKS_CONFIG_PROFILE |
profile |
profile (Python)setProfile(Java)Profile (開始) |
驗證欄位
使用這些環境變數或欄位來強制執行特定類型的 Databricks 驗證。
| 一般名稱 | Description | 環境變數 | Terraform 欄位 |
Config 欄位 |
|---|---|---|---|---|
| Databricks 驗證類型 | (字串) 當環境中有多個驗證屬性可用時,將使用此引數指定的驗證類型。 請參閱 支援的驗證類型。 | DATABRICKS_AUTH_TYPE |
auth_type |
auth_type (Python)setAuthType(Java)AuthType (開始) |
| OIDC 權杖環境變數 | (字串)包含 IdP 發行的 OIDC 權杖的環境變數名稱。 與驗證類型一起使用 env-oidc 。 預設為 DATABRICKS_OIDC_TOKEN。 |
DATABRICKS_OIDC_TOKEN_ENV |
oidc_token_env |
oidc_token_env (Python)setOIDCTokenEnv(Java)OIDCTokenEnv (開始) |
| OIDC 權杖檔案路徑 | (字串)包含 IdP 發行的 OIDC 權杖的本機檔案路徑。 與驗證類型一起使用 file-oidc 。 |
DATABRICKS_OIDC_TOKEN_FILEPATH |
oidc_token_filepath |
oidc_token_filepath (Python)setOIDCTokenFilepath(Java)OIDCTokenFilepath (開始) |
支援的驗證類型
支援的 Databricks 驗證類型欄位值包括:
-
oauth-m2m: 透過 OAuth 2.0 使用 Databricks 服務主體進行機器對機器 (M2M) 驗證。 請參閱 使用 OAuth 授權服務主體存取 Azure Databricks。 -
pat: 使用 Databricks 個人存取權杖進行驗證。 請參閱 使用 Azure Databricks 個人存取權杖 (舊版) 進行驗證。 -
databricks-cli: 使用 OAuth 2.0 與 Databricks CLI 進行互動登入。 請參閱 使用 OAuth 授權使用者存取 Azure Databricks。 -
oidc-token: 針對與身分識別提供者 (IdP) 的權杖同盟,其中 Databricks 會將 IdP 發行的 OIDC 權杖交換為 Databricks OAuth 權杖。 請參閱 使用身分提供者權杖進行驗證。 -
env-oidc: 當您的 IdP 權杖儲存在環境變數 ()DATABRICKS_OIDC_TOKEN中時,用於聯合。 請參閱 使用身分提供者權杖進行驗證。 -
file-oidc: 用於聯邦認證,當您的 IdP 權杖儲存在本機檔案DATABRICKS_OIDC_TOKEN_FILEPATH中時。 請參閱 使用身分提供者權杖進行驗證。 -
github-oidc: 針對透過 OIDC 權杖的 GitHub Actions 同盟驗證。 請參閱 啟用 GitHub Actions 的工作負載身分識別同盟。 -
azure-devops-oidc: 針對透過 OIDC 權杖的 Azure DevOps 同盟驗證。 請參閱 為 Azure DevOps Pipelines 啟用工作負載身分識別聯邦功能。
-
azure-msi: 使用 Azure 受控服務身分識別 (MSI) 進行驗證。 請參閱 使用 Azure 受控識別進行驗證。 -
azure-client-secret: 使用 Azure 服務主體搭配用戶端密碼進行驗證。 請參見 使用 Microsoft Entra 服務主體進行身份驗證。