Geïntegreerde verificatie van Databricks-client

Artikel
02/05/2025

Geïntegreerde verificatie van Databricks-client centraliseert het instellen en automatiseren van verificatie voor Azure Databricks als onderdeel van OAuth-autorisatie. Hiermee kunt u Databricks-verificatie eenmaal configureren en deze configuratie vervolgens gebruiken voor meerdere Databricks-hulpprogramma's en SDK's zonder verdere verificatieconfiguratiewijzigingen.

Deelnemende hulpprogramma's en SDK's

Deelnemende Databricks-hulpprogramma's en SDK's zijn:

Alle deelnemende hulpprogramma's en SDK's accepteren speciale omgevingsvariabelen en Azure Databricks-configuratieprofielen voor verificatie. De Databricks Terraform-provider en de Databricks SDK's voor Python, Java en Go accepteren ook directe configuratie van verificatie-instellingen binnen code. Zie Lokale ontwikkelhulpprogramma's voor de documentatie van het hulpprogramma of de SDK voor meer informatie.

Standaardmethoden voor geïntegreerde clientverificatie

Wanneer een hulpprogramma of SDK toegang tot Azure Databricks moet autoriseren, wordt standaard de volgende verificatietypen uitgevoerd in de volgende volgorde. Wanneer het hulpprogramma of de SDK slaagt met het type verificatie dat wordt geprobeerd, probeert het niet meer te verifiëren met de resterende verificatietypen. Als u wilt afdwingen dat een SDK wordt geverifieerd met een specifiek verificatietype, stelt u het veld databricks-verificatietype van de Config-API in.

Voor elk verificatietype dat het deelnemende hulpprogramma of de SDK probeert te proberen, probeert het hulpprogramma of de SDK verificatiereferenties op de volgende locaties te vinden, in de volgende volgorde. Wanneer het hulpprogramma of de SDK slaagt in het vinden van verificatiereferenties die kunnen worden gebruikt, stopt het hulpprogramma of de SDK met het zoeken naar verificatiereferenties op de resterende locaties.

Aan referenties gerelateerde Config API-velden (voor SDK's). Zie de referentiedocumentatie van de SDK om Config velden in te stellen.
Omgevingsvariabelen met betrekking tot referenties.
Referentiegerelateerde velden in het DEFAULT configuratieprofiel in het .databrickscfg bestand. Zie (/dev-tools/auth/config-profiles.md) om configuratieprofielvelden in te stellen.
Alle gerelateerde verificatiereferenties die in de cache worden opgeslagen door de Azure CLI. Zie Azure CLI-verificatie.

Databricks raadt u aan om een aangepast -configuratieprofiel in het .databrickscfg-bestand te maken, de vereiste velden hieronder toe te voegen voor uw Databricks-verificatietype aan het aangepaste configuratieprofiel, en vervolgens de omgevingsvariabele DATABRICKS_CONFIG_PROFILE in te stellen op de naam van het aangepaste configuratieprofiel.

Omgevingsvariabelen en -velden voor geïntegreerde clientverificatie

De volgende tabellen bevatten de namen en beschrijvingen van de ondersteunde omgevingsvariabelen en -velden voor geïntegreerde verificatie van databricks-clients. In de volgende tabellen:

De omgevingsvariabele, indien van toepassing, is de naam van de omgevingsvariabele.
.databrickscfg veld, indien van toepassing, is de naam van het veld in een Azure Databricks-configuratieprofielbestand of Databricks Terraform-configuratie. Zie .databrickscfgvoor het instellen van velden.
Terraform-veldis, indien van toepassing, de naam van het veld binnen een Databricks Terraform-configuratie. Als u Databricks Terraform-velden wilt instellen, raadpleegt u Authentication in de documentatie van de Databricks Terraform-provider.
Config veld is de naam van het veld in de Config API voor de opgegeven SDK.

Algemene omgevingsvariabelen en -velden voor host, token en account-id

Algemene naam	Beschrijving	Omgevingsvariabele	`.databrickscfg` veld, Terraform-veld	`Config` veld
Azure Databricks-host	(Tekenreeks) De Azure Databricks-host-URL voor het Azure Databricks-werkruimte-eindpunt of het eindpunt van de Azure Databricks-accounts.	`DATABRICKS_HOST`	`host`	`host` (Python), `setHost` (Java), `Host` (Go)
Azure Databricks-token	(Tekenreeks) Het persoonlijke toegangstoken van Azure Databricks of het Microsoft Entra ID-token.	`DATABRICKS_TOKEN`	`token`	`token` (Python), `setToken` (Java), `Token` (Go)
Azure Databricks-account-id	(Tekenreeks) De azure Databricks-account-id voor het Azure Databricks-accounteindpunt. Heeft alleen effect wanneer de Azure Databricks-host ook is ingesteld op `https://accounts.azuredatabricks.net`.	`DATABRICKS_ACCOUNT_ID`	`account_id`	`account_id` (Python), `setAccountID` (Java), `AccountID` (Go)

Azure-specifieke omgevingsvariabelen en -velden

Algemene naam	Beschrijving	Omgevingsvariabele	`.databrickscfg` veld, Terraform-veld	`Config` veld
Azure-client-id	(Tekenreeks) De toepassings-id van de Microsoft Entra ID-service-principal. Gebruik met verificatie van door Azure beheerde identiteiten en verificatie van de Service-principal van Microsoft Entra ID.	`ARM_CLIENT_ID`	`azure_client_id`	`azure_client_id` (Python), `setAzureClientID` (Java), `AzureClientID` (Go)
Azure-clientgeheim	(Tekenreeks) Het clientgeheim van de Microsoft Entra ID-service-principal. Gebruik met een Verificatie van de Service-principal van Microsoft Entra ID.	`ARM_CLIENT_SECRET`	`azure_client_secret`	`azure_client_secret` (Python), `setAzureClientSecret` (Java), `AzureClientSecret` (Go)
Client ID	(Tekenreeks) De client-id van de beheerde service-principal van Azure Databricks of de beheerde service-principal van Microsoft Entra ID. Gebruiken met OAuth M2M-verificatie.	`DATABRICKS_CLIENT_ID`	`client_id`	`client_id` (Python), `setClientId` (Java), `ClientId` (Go)
Clientgeheim	(Tekenreeks) Het clientgeheim van de beheerde service-principal van Azure Databricks of de beheerde service-principal van Microsoft Entra ID. Gebruiken met OAuth M2M-verificatie.	`DATABRICKS_CLIENT_SECRET`	`client_secret`	`client_secret` (Python), `setClientSecret` (Java), `ClientSecret` (Go)
Azure-omgeving	(Tekenreeks) Het Azure-omgevingstype. Standaard ingesteld op `PUBLIC`.	`ARM_ENVIRONMENT`	`azure_environment`	`azure_environment` (Python), `setAzureEnvironment` (Java), `AzureEnvironment` (Go)
Azure-tenant-id	(Tekenreeks) De tenant-id van de Microsoft Entra ID-service-principal.	`ARM_TENANT_ID`	`azure_tenant_id`	`azure_tenant_id` (Python), `setAzureTenantID` (Java), `AzureTenantID` (Go)
Msi gebruiken in Azure	(Booleaanse waarde) True to use Azure Managed Service Identity passwordless authentication flow for service principals. Vereist dat de Azure-resource-id ook wordt ingesteld.	`ARM_USE_MSI`	`azure_use_msi`	`AzureUseMSI` (Go)
Azure-resource-id	(Tekenreeks) De Azure Resource Manager-id voor de Azure Databricks-werkruimte.	`DATABRICKS_AZURE_RESOURCE_ID`	`azure_workspace_resource_id`	`azure_workspace_resource_id` (Python), `setAzureResourceID` (Java), `AzureResourceID` (Go)

.databrickscfg-specifieke omgevingsvariabelen en -velden

Gebruik deze omgevingsvariabelen of -velden om niet-standaardinstellingen voor .databrickscfgop te geven. Zie ook Configuratieprofielen voor Azure Databricks.

Algemene naam	Beschrijving	Omgevingsvariabele	Terraform-veld	`Config` veld
`.databrickscfg` bestandspad	(Tekenreeks) Een niet-standaardpad naar de `.databrickscfg` bestand.	`DATABRICKS_CONFIG_FILE`	`config_file`	`config_file` (Python), `setConfigFile` (Java), `ConfigFile` (Go)
`.databrickscfg` standaardprofiel	(Tekenreeks) Het standaard benoemde profiel dat moet worden gebruikt, behalve `DEFAULT`.	`DATABRICKS_CONFIG_PROFILE`	`profile`	`profile` (Python), `setProfile` (Java), `Profile` (Go)

Verificatietypeveld

Gebruik deze omgevingsvariabele of -veld om af te dwingen dat een SDK een specifiek type Databricks-verificatie gebruikt.

Algemene naam	Beschrijving	Terraform-veld	`Config` veld
Verificatietype databricks	(Tekenreeks) Wanneer er meerdere verificatiekenmerken beschikbaar zijn in de omgeving, gebruikt u het verificatietype dat door dit argument is opgegeven.	`auth_type`	`auth_type` (Python), `setAuthType` (Java), `AuthType` (Go)

Ondersteunde veldwaarden voor databricks-verificatietypen zijn:

oauth-m2m: stel deze waarde in als u een Databricks-service-principal gebruikt voor M2M-verificatie met OAuth 2.0. Zie Toegang zonder toezicht autoriseren tot Azure Databricks-resources met een service-principal met behulp van OAuthvoor meer informatie.
pat: stel deze waarde in als u persoonlijke toegangstokens van Databricks gebruikt. Zie De verificatie van persoonlijke toegangstokens van Azure Databricks voor meer informatie.
databricks-cli: stel deze waarde in als u de Databricks CLI gebruikt met OAuth 2.0. Zie Interactieve toegang tot Azure Databricks-resources autoriseren met een gebruikersaccount met behulp van OAuthvoor meer informatie.
azure-msi: stel deze waarde in als u een Azure Managed Service Identity (MSI) gebruikt. Zie Verificatie van door Azure beheerde identiteiten voor meer informatie.
azure-client-secret: stel deze waarde in als u een Azure-service-principal met clientgeheimen gebruikt. Zie ms Entra-service-principalverificatie voor meer informatie.

Delen via