Sdílet prostřednictvím

Jednotné ověřování klienta Databricks

Jednotné ověřování klienta Databricks centralizuje nastavení a automatizaci ověřování do Azure Databricks v rámci autorizace OAuth. Umožňuje konfigurovat ověřování Databricks jednou a pak tuto konfiguraci používat napříč několika nástroji a sadami SDK Databricks bez dalších změn konfigurace ověřování.

Zúčastněné nástroje a sady SDK

Mezi zúčastněné nástroje a sady SDK Databricks patří:

Všechny zúčastněné nástroje a sady SDK přijímají pro ověřování speciální proměnné prostředí a konfigurační profily Azure Databricks. Zprostředkovatel Databricks Terraform a sady SDK Databricks pro Python, Javu a Go také přijímají přímou konfiguraci nastavení ověřování v kódu. Podrobnosti najdete v tématu Místní vývojové nástroje pro dokumentaci k nástroji nebo sadě SDK.

Výchozí metody pro jednotné ověřování klienta

Kdykoli nástroj nebo sada SDK musí autorizovat přístup k Azure Databricks, pokusí se ve výchozím nastavení použít následující typy ověřování. Když se nástroj nebo sada SDK úspěšně pokusí o typ ověřování, přestane se pokoušet ověřit pomocí zbývajících typů ověřování. Pro vynucení autentizace SDK konkrétním typem ověřování nastavte Config pole typu ověřování v rozhraní API Databricks.

  1. Ověřování tokenu PAT služby Azure Databricks
  2. Autorizace bezobslužného přístupu k prostředkům Azure Databricks pomocí služebního účtu a OAuth
  3. autorizace interaktivního přístupu k prostředkům Azure Databricks pomocí uživatelského účtu pomocí OAuth
  4. Ověřování spravovaných identit Azure
  5. Ověřování instančního objektu MS Entra
  6. Ověřování přes Azure CLI

Pro každý typ ověřování se nástroj nebo sada SDK pokusí najít ověřovací údaje v následujících místech a v tomto pořadí. Pokud je nástroj nebo sada SDK úspěšné při hledání přihlašovacích údajů pro ověřování, které je možné použít, nástroj nebo sada SDK se přestanou pokoušet najít přihlašovací údaje pro ověření ve zbývajících umístěních.

  1. Pole rozhraní API související s Config přihlašovacími údaji (pro sady SDK) Pokud chcete nastavit Config pole, prohlédněte si referenční dokumentaci sady SDK.
  2. Proměnné prostředí související s přihlašovacími údaji
  3. Pole související s přihlašovacími údaji v konfiguračním DEFAULT profilu v .databrickscfg souboru. Pro nastavení polí konfiguračního profilu viz (/dev-tools/auth/config-profiles.md).
  4. Všechny související přihlašovací údaje pro ověřování uložené v mezipaměti Azure CLI Viz ověřování Azure CLI.

Aby byl váš kód co nejvíce přenosný, Databricks doporučuje, abyste v souboru vytvořili vlastní .databrickscfg, do vlastního konfiguračního profilu přidali požadovaná pole pro cílový typ ověřování Databricks a poté nastavili proměnnou prostředí DATABRICKS_CONFIG_PROFILE na název vlastního konfiguračního profilu.

Proměnné prostředí a pole pro jednotné ověřování klientů

Následující tabulky obsahují názvy a popisy podporovaných proměnných prostředí a polí pro jednotné ověřování klienta Databricks. V následujících tabulkách:

  • Proměnná prostředí, pokud je to relevantní, je název proměnné prostředí.
  • .databrickscfg pokud je to možné, je název pole v souboru konfiguračních profilů Azure Databricks. Chcete-li nastavit pole .databrickscfg, přečtěte si konfigurační profily Azure Databricks .
  • pole Terraformu, kde je to možné, je název pole v konfiguraci Databricks Terraform. Pokud chcete nastavit pole Databricks Terraform, přečtěte si sekci Ověřování v dokumentaci poskytovatele Databricks Terraform.
  • Config pole je název pole v rámci Config rozhraní API pro zadanou sadu SDK.

Proměnné prostředí a pole obecného hostitele, tokenu a ID účtu

Běžný název Popis Proměnná prostředí .databrickscfg pole, pole Terraformu Config pole
Hostitel Azure Databricks (Řetězec) Adresa URL hostitele Azure Databricks pro koncový bod pracovního prostoru Azure Databricks nebo koncový bod účtů Azure Databricks. DATABRICKS_HOST host host (Python),
setHost (Java),
Host (Jít)
Token Azure Databricks (Řetězec) Osobní přístupový token Azure Databricks nebo token Microsoft Entra ID. DATABRICKS_TOKEN token token (Python),
setToken (Java),
Token (Jít)
ID účtu Azure Databricks (Řetězec) ID účtu Azure Databricks pro koncový bod účtu Azure Databricks. Má účinek pouze v případech, kdy je hostitel Azure Databricks nastavený také na https://accounts.azuredatabricks.net. DATABRICKS_ACCOUNT_ID account_id account_id (Python),
setAccountID (Java),
AccountID (Jít)

Proměnné a pole prostředí specifické pro Azure

Běžný název Popis Proměnná prostředí .databrickscfg field, Terraform field Config pole
ID klienta Azure (Řetězec) ID aplikace služebního principála Microsoft Entra ID. Používá se s ověřováním spravovaných identit Azure a ověřováním instančního objektu Microsoft Entra ID. ARM_CLIENT_ID azure_client_id azure_client_id (Python),
setAzureClientID (Java),
AzureClientID (Jít)
Tajný klíč klienta Azure (Řetězec) Tajný klíč klienta instančního objektu Microsoft Entra ID. Používá se s ověřením pomocí služebního objektu Microsoft Entra ID. ARM_CLIENT_SECRET azure_client_secret azure_client_secret (Python),
setAzureClientSecret (Java),
AzureClientSecret (Jít)
ID klienta (Řetězec) Identifikátor klienta spravované hlavní služby Azure Databricks nebo spravované hlavní služby Microsoft Entra ID. Používá se s ověřováním OAuth M2M. DATABRICKS_CLIENT_ID client_id client_id (Python),
setClientId (Java),
ClientId (Jít)
Tajný klíč klienta (Řetězec) Tajný klíč klienta spravovaného servisního objektu Azure Databricks nebo servisního objektu Microsoft Entra ID. Používá se s ověřováním OAuth M2M. DATABRICKS_CLIENT_SECRET client_secret client_secret (Python),
setClientSecret (Java),
ClientSecret (Jít)
Prostředí Azure (Řetězec) Typ prostředí Azure. Výchozí hodnota je PUBLIC. ARM_ENVIRONMENT azure_environment azure_environment (Python),
setAzureEnvironment (Java),
AzureEnvironment (Jít)
ID klienta Azure (Řetězec) ID tenanta principálu služby Microsoft Entra ID. ARM_TENANT_ID azure_tenant_id azure_tenant_id (Python),
setAzureTenantID (Java),
AzureTenantID (Jít)
Azure používá MSI (Logická hodnota) Je pravda, že pro instanční objekty použijete tok ověřování bez hesla identity spravované služby Azure. Je třeba nastavit také identifikátor prostředku Azure. ARM_USE_MSI azure_use_msi AzureUseMSI (Jít)
ID prostředku Azure (Řetězec) ID Azure Resource Manageru pro pracovní prostor Azure Databricks DATABRICKS_AZURE_RESOURCE_ID azure_workspace_resource_id azure_workspace_resource_id (Python),
setAzureResourceID (Java),
AzureResourceID (Jít)

proměnné prostředí a pole specifická pro .databrickscfg

Pomocí těchto proměnných prostředí nebo polí můžete zadat jiné než výchozí nastavení pro .databrickscfg. Viz také Azure Databricks konfigurační profily.

Běžný název Popis Proměnná prostředí Terraformové pole Config pole
.databrickscfg cesta k souboru (Řetězec) Jiná než výchozí cesta k
.databrickscfg soubor.		 DATABRICKS_CONFIG_FILE config_file config_file (Python),
setConfigFile (Java),
ConfigFile (Jít)
.databrickscfg výchozí profil (Řetězec) Výchozí pojmenovaný profil, který se má použít, jiný než DEFAULT. DATABRICKS_CONFIG_PROFILE profile profile (Python),
setProfile (Java),
Profile (Jít)

Pole Typu ověřování

Tuto proměnnou prostředí nebo pole použijte k vynucení použití konkrétního typu ověřování Databricks přes SDK.

Běžný název Popis Proměnná prostředí Terraformové pole Config pole
Typ ověřování Databricks (Řetězec) Pokud je v prostředí k dispozici více atributů ověřování, použijte typ ověřování určený tímto argumentem. DATABRICKS_AUTH_TYPE auth_type auth_type (Python)
setAuthType (Java)
AuthType (Jít)

Mezi podporované hodnoty polí typu ověřování Databricks patří:

  • azure-msi: Tuto hodnotu nastavte, pokud používáte identitu spravované služby Azure (MSI). Další podrobnosti najdete v tématu Ověřování spravovaných identit Azure.
  • azure-client-secret: Tuto hodnotu nastavte, pokud používáte instanční objekt Azure s tajnými klíči klienta. Další podrobnosti naleznete v tématu MS Entra instanční objekt ověřování.