Jednotné ověřování klienta Databricks

  • Článek

Jednotné ověřování klienta Databricks centralizuje nastavení a automatizaci ověřování do Azure Databricks. 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 Vývojářské nástroje v dokumentaci k nástroji nebo sadě SDK.

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

Kdykoli se nástroj nebo sada SDK musí ověřit ve službě Azure Databricks, ve výchozím nastavení se pokusí 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í. Pokud chcete vynutit, aby se sada SDK ověřila pomocí konkrétního typu ověřování, nastavte Config pole typu ověřování Databricks rozhraní API.

  1. Ověřování tokenu PAT služby Azure Databricks
  2. Ověřování přístupu k Azure Databricks pomocí instančního objektu pomocí OAuth (OAuth M2M)
  3. Ověřování přístupu k Azure Databricks pomocí uživatelského účtu pomocí OAuth (OAuth U2M)
  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í, který se zúčastněné nástroje nebo sada SDK pokusí, se nástroj nebo sada SDK pokusí najít přihlašovací údaje pro ověřování v následujících umístěních v následujícím 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édni si referenční dokumentace 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. Pokud chcete nastavit pole konfiguračního profilu, přečtěte si téma (/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.

Pro zajištění maximální přenositelnosti kódu doporučuje Databricks vytvořit vlastní konfigurační profil v .databrickscfg souboru, přidat níže uvedená pole pro cílový typ ověřování Databricks do vlastního konfiguračního profilu a pak nastavit DATABRICKS_CONFIG_PROFILE proměnnou prostředí na název vlastního konfiguračního profilu.

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

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:

  • Pokud je to možné, proměnná prostředí 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 nebo v konfiguraci Terraformu Databricks. Pokud chcete nastavit .databrickscfg pole, podívejte se na konfigurační profily Azure Databricks.
  • Pokud je to možné, je pole Terraformu název pole v konfiguraci Terraformu Databricks. Pokud chcete nastavit pole Databricks Terraform, přečtěte si téma Ověřování v dokumentaci zprostředkovatele 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 field, Terraform field 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 (Přejít)
Token Azure Databricks (Řetězec) Token pat azure Databricks nebo token MICROSOFT Entra ID. DATABRICKS_TOKEN token token (Python),
setToken (Java),
Token (Přejí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 (Přejí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 instančního objektu 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 (Přejít)
Tajný klíč klienta Azure (Řetězec) Tajný klíč klienta instančního objektu Microsoft Entra ID. Používá se s ověřováním instančního objektu Microsoft Entra ID. ARM_CLIENT_SECRET azure_client_secret azure_client_secret (Python),
setAzureClientSecret (Java),
AzureClientSecret (Přejít)
Client ID (Řetězec) ID klienta spravovaného instančního objektu Azure Databricks nebo spravovaného instančního objektu Microsoft Entra ID. Používá se s ověřováním OAuth M2M. DATABRICKS_CLIENT_ID client_id client_id (Python),
setClientId (Java),
ClientId (Přejít)
Tajný klíč klienta (Řetězec) Tajný klíč klienta spravovaného instančního objektu Azure Databricks nebo spravovaného instanční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 (Přejít)
Prostředí Azure (Řetězec) Typ prostředí Azure. Výchozí hodnota PUBLICje . ARM_ENVIRONMENT azure_environment azure_environment (Python),
setAzureEnvironment (Java),
AzureEnvironment (Přejít)
ID tenanta Azure (Řetězec) ID tenanta instančního objektu Microsoft Entra ID. ARM_TENANT_ID azure_tenant_id azure_tenant_id (Python),
setAzureTenantID (Java),
AzureTenantID (Přejít)
Azure use MSI (Logická hodnota) Je pravda, že pro instanční objekty použijete tok ověřování bez hesla identity spravované služby Azure. Vyžaduje také nastavení ID prostředku Azure. ARM_USE_MSI azure_use_msi AzureUseMSI (Přejí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 (Přejí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é konfigurační profily Azure Databricks.

Běžný název Popis Proměnná prostředí Pole Terraformu 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 (Přejí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 (Přejí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 sadou SDK.

Běžný název Popis Pole Terraformu 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. auth_type auth_type (Python),
setAuthType (Java),
AuthType (Přejít)

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