本頁說明如何使用 Databricks CLI 和 REST API 授權存取 Azure Databricks 資源。 它說明不同的授權方法、使用時機,以及如何為您的使用案例設定驗證。
若要使用 CLI 或 REST API 存取 Azure Databricks 資源,您必須使用具有適當許可權的 Azure Databricks 帳戶進行驗證。 您的 Azure Databricks 系統管理員或具有系統管理員許可權的使用者會設定帳戶。
帳戶和 API 類型
您可以使用兩種類型的帳戶進行驗證:
- 使用者帳戶: 用於互動式 CLI 指令與 API 呼叫。
- 服務主體: 用於自動化的 CLI 指令與 API 呼叫,無需人工操作。
您可以使用 MS Entra 服務主體來授權存取您的 Azure Databricks 帳戶或工作區。 請參見 使用 Microsoft Entra 服務主體進行身份驗證。 不過,Databricks 建議使用 Databricks 服務主體並搭配 OAuth,因為其存取權杖對於 Databricks 獨有的授權更具穩定性。
Azure Databricks 有兩種類型的 API,需要不同的驗證方法:
- 帳戶層級 API: 供帳戶擁有者與管理員使用,託管於帳戶主控台 URL。 請參閱帳戶層級 API。
- 工作區層級 API: 提供給工作區使用者與管理員,並託管於工作區 URL。 請參閱 工作區層級 API。
授權方法
選擇最適合您使用案例的授權方法。 Azure Databricks 工具和 SDK 支援多種授權方法,因此您可以針對您的案例選取最適當的授權方法。
對於需要資源專屬 OAuth 令牌的服務,請參閱 「請求帶有授權詳細資料的 OAuth 令牌」。
| Method | Description | 用例 |
|---|---|---|
| Databricks OAuth 權杖同盟 (建議) | 身份提供者向用戶或服務主體提供的 OAuth 令牌。 | 可讓您向 Azure Databricks 進行驗證,而不需要管理 Databricks 秘密。 |
| Databricks OAuth for服務主體 | 服務主體的短期 OAuth 權杖。 | 無人值守、自動化及 CI/CD 工作流程,使用機器對機器(M2M)OAuth 與用戶端密鑰。 若要以服務主體身分進行無密鑰的互動式存取,請使用 OAuth 代表使用者(OBO)。 請參考 使用 OAuth OBO 以服務主體身分進行驗證。 |
| 用戶用 OAuth(OAuth U2M) | 使用者的短效 OAuth 權杖。 | 有人參與的驗證案例,當您出現提示時,您會使用 Web 瀏覽器即時向 Azure Databricks 進行驗證。 |
| Azure 受控服務身分識別授權 | Microsoft Entra ID 驗證憑證,用於 Azure 受控識別。 | 只能與支援受控識別的 Azure 資源搭配使用,例如 Azure 虛擬機器。 |
| Microsoft Entra ID 服務主體授權 | Microsoft Entra ID 服務主體的 Microsoft Entra ID 權杖。 | 只能與支援 Microsoft Entra ID 權杖且不支援受控識別的 Azure 資源搭配使用,例如 Azure DevOps。 |
| Azure CLI 授權 | 使用者或 Microsoft Entra ID 服務主體的 Microsoft Entra ID 權杖。 | 使用 Azure CLI 授權存取 Azure 資源和 Azure Databricks。 |
| Microsoft Entra ID 使用者授權 | 使用者的 Microsoft Entra ID 令牌。 | 只能與僅支援 Microsoft Entra ID 權杖的 Azure 資源搭配使用。 Databricks 不建議手動為 Azure Databricks 使用者建立 Microsoft Entra ID 權杖。 |
統一身份驗證
Azure Databricks 統一驗證提供一套一致的方式,讓所有支援的工具與 SDK 都能設定驗證。 此方法使用標準環境變數和組態設定檔來儲存認證值,因此您可以執行 CLI 命令或呼叫 API,而無需重複設定驗證。
統一驗證會以不同的方式處理帳戶類型:
- 使用者授權: OAuth 會自動建立並管理支援統一驗證的工具的存取權杖。 請參閱 使用 OAuth 授權使用者存取 Azure Databricks。
- 服務主體授權:OAuth 需要用戶端憑證(用戶端 ID 與密鑰),這些憑證在您指派服務主體給工作區後,Azure Databricks 會提供。 請參閱 使用 OAuth 授權服務主體存取 Azure Databricks。
若要使用 OAuth 存取權杖,您的 Azure Databricks 工作區或帳戶系統管理員必須授與您的使用者帳戶或服務主體 CAN USE ,您的程式碼將存取之帳戶和工作區功能的許可權。
環境變數
若要設定統一驗證,請設定下列環境變數。 有些變數同時適用於使用者和服務主體授權,而其他變數則僅適用於服務主體。
| 環境變數 | Description |
|---|---|
DATABRICKS_HOST |
Azure Databricks 帳戶控制台 (https://accounts.azuredatabricks.net) 或 Azure Databricks 工作區 (https://{workspace-url-prefix}.azuredatabricks.net) 的 URL。 根據程式碼執行的作業類型進行選擇。 |
DATABRICKS_ACCOUNT_ID |
用於 Azure Databricks 帳戶作業。 這是您的 Azure Databricks 帳戶識別碼。 若要取得它,請參閱 尋找您的帳戶標識碼。 |
DATABRICKS_CLIENT_ID |
(僅限服務主體 OAuth)建立 服務主體時指派的用戶端標識碼。 |
DATABRICKS_CLIENT_SECRET |
(僅限服務主體 OAuth)您在 建立服務主體時產生的客戶端密碼。 |
不要手動設定環境變數,請考慮在用戶端電腦上的 Databricks 組態配置檔 (.databrickscfg) 中定義它們。
組態設定檔
Azure Databricks 組態配置檔包含 Azure Databricks 工具和 SDK 授權存取所需的設定和認證。 這些設定檔會儲存在本機用戶端檔案 (通常命名 .databrickscfg) 中,供您的工具、SDK、指令碼和應用程式使用。
如需詳細資訊,請參閱 Azure Databricks 組態配置檔。
第三方集成
與第三方服務和工具整合時,您必須使用這些服務所提供的驗證機制。 不過,Azure Databricks 提供常見整合的支援:
- Databricks Terraform 提供者:使用 Azure Databricks 使用者帳戶從 Terraform 存取 Azure Databricks API。 請參閱使用 Terraform 佈建服務主體。
- Git 提供者:GitHub、GitLab 和 Bitbucket 可以透過 Databricks 服務主體存取 Azure Databricks API。 請參閱 CI/CD 的服務主體。
- Jenkins:使用 Databricks 服務主體存取 Azure Databricks API。 請參閱 Azure Databricks 上使用 Jenkins 的 CI/CD。
- Azure DevOps:使用 MS Entra ID 服務主體存取 Azure Databricks API。 請參閱 在 Azure Databricks 上使用 Azure DevOps 進行驗證。