Partager via


Variables et champs d’environnement pour l’authentification unifiée

Cette référence répertorie les variables d’environnement et les champs de configuration pour l’authentification unifiée Databricks. Ils fonctionnent de manière cohérente dans l’interface CLI Databricks, le fournisseur Terraform et les kits SDK pour Python, Java et Go.

Utilisez cette référence pour configurer l’authentification ou résoudre les problèmes d’authentification. Chaque entrée inclut :

  • Variable d’environnement : Définissez-le dans votre environnement shell.
  • .databrickscfg champ : utilisez-le dans les profils de configuration.
  • Champ Terraform : Configurez-le dans votre bloc de fournisseur Terraform. Consultez l’authentification dans la documentation du fournisseur Databricks Terraform.
  • Config champ : utilisez-le lors de la configuration des kits SDK par programmation avec le Config API.

Champs de configuration généraux

Ces variables configurent les paramètres de connexion et de calcul de base pour Databricks.

Nom courant Descriptif Variable d’environnement Champ .databrickscfg, champ Terraform Config champ
Hôte Azure Databricks (Chaîne) URL de l’hôte Azure Databricks pour le point de terminaison de l’espace de travail Azure Databricks ou le point de terminaison des comptes Azure Databricks. DATABRICKS_HOST host host (Python)
setHost (Java)
Host (Allez)
Jeton Azure Databricks (Chaîne) Le jeton d’accès personnel Azure Databricks ou le jeton Microsoft Entra ID. DATABRICKS_TOKEN token token (Python)
setToken (Java)
Token (Allez)
ID de compte Azure Databricks (Chaîne) ID de compte Azure Databricks pour le point de terminaison du compte Azure Databricks. N’a effet que lorsque l’hôte Azure Databricks est également défini sur https://accounts.azuredatabricks.net. DATABRICKS_ACCOUNT_ID account_id account_id (Python)
setAccountID (Java)
AccountID (Allez)
ID du Cluster (String) ID du cluster à utiliser DATABRICKS_CLUSTER_ID cluster_id cluster_id
Informatique sans serveur (String) Paramètre d’activation automatique du calcul serverless. Les valeurs valides sont auto. DATABRICKS_SERVERLESS_COMPUTE_ID serverless_compute_id serverless_compute_id
Nom courant Descriptif Variable d’environnement Champ .databrickscfg, champ Terraform Config champ
ID client Azure (String) L’ID d’application du principal du service Microsoft Entra ID. Utiliser avec l’authentification des identités managées Microsoft Entra ID et l’authentification du principal de service Azure. ARM_CLIENT_ID azure_client_id azure_client_id (Python)
setAzureClientID (Java)
AzureClientID (Allez)
Clé secrète client Azure (String) Secret client du principal du service Microsoft Entra ID. Utilisez avec une authentification du principal de service Microsoft Entra ID. ARM_CLIENT_SECRET azure_client_secret azure_client_secret (Python)
setAzureClientSecret (Java)
AzureClientSecret (Allez)
ID de client (Chaîne) L’ID client du principal du service géré Azure Databricks ou du principal du service géré Microsoft Entra ID. Utiliser avec l’authentification OAuth M2M. DATABRICKS_CLIENT_ID client_id client_id (Python)
setClientId (Java)
ClientId (Allez)
Clé secrète client (Chaîne) Le secret client du principal du service géré Azure Databricks ou du principal du service géré Microsoft Entra ID. Utiliser avec l’authentification OAuth M2M. DATABRICKS_CLIENT_SECRET client_secret client_secret (Python)
setClientSecret (Java)
ClientSecret (Allez)
Environnement Azure (Chaîne) Type d’environnement Azure. La valeur par défaut est PUBLIC. ARM_ENVIRONMENT azure_environment azure_environment (Python)
setAzureEnvironment (Java)
AzureEnvironment (Allez)
ID locataire Azure (String) L'ID de locataire du principal Entra ID de Microsoft. ARM_TENANT_ID azure_tenant_id azure_tenant_id (Python)
setAzureTenantID (Java)
AzureTenantID (Allez)
Azure utilise MSI (Booléen) True pour utiliser le flux d’authentification sans mot de passe Azure Managed Service Identity pour les principaux de service. Nécessite également la définition de l’ID de la ressource Azure. ARM_USE_MSI azure_use_msi AzureUseMSI (Allez)
ID de ressource Azure (Chaîne) ID d’Azure Resource Manager pour l’espace de travail Azure Databricks. DATABRICKS_AZURE_RESOURCE_ID azure_workspace_resource_id azure_workspace_resource_id (Python)
setAzureResourceID (Java)
AzureResourceID (Allez)

Champs spécifiques à .databrickscfg

Utilisez ces variables ou champs d’environnement pour spécifier des paramètres autres que ceux par défaut pour .databrickscfg. Consultez aussi Profils de configuration Azure Databricks.

Nom courant Descriptif Variable d’environnement Champ Terraform Config champ
Chemin d’accès au fichier .databrickscfg (String) Chemin d’accès non par défaut au .databrickscfg fichier. DATABRICKS_CONFIG_FILE config_file config_file (Python)
setConfigFile (Java)
ConfigFile (Allez)
Profil par défaut .databrickscfg (Chaîne) Profil nommé par défaut à utiliser, autre que DEFAULT. DATABRICKS_CONFIG_PROFILE profile profile (Python)
setProfile (Java)
Profile (Allez)

Champs d’authentification

Utilisez ces variables d’environnement ou champs pour appliquer un type spécifique d’authentification Databricks.

Nom courant Descriptif Variable d’environnement Champ Terraform Config champ
Type d'authentification Databricks (Chaîne) Lorsque plusieurs attributs d’authentification sont disponibles dans l’environnement, utilisez le type d’authentification spécifié par cet argument. Consultez les types d’authentification pris en charge. DATABRICKS_AUTH_TYPE auth_type auth_type (Python)
setAuthType (Java)
AuthType (Allez)
Variable d’environnement de jeton OIDC (String) Nom de la variable d’environnement qui contient votre jeton OIDC émis par idP. Utilisé avec env-oidc le type d’authentification. La valeur par défaut est DATABRICKS_OIDC_TOKEN. DATABRICKS_OIDC_TOKEN_ENV oidc_token_env oidc_token_env (Python)
setOIDCTokenEnv (Java)
OIDCTokenEnv (Allez)
Chemin du fichier de jeton OIDC (String) Chemin d’accès à un fichier local qui contient votre jeton OIDC émis par le fournisseur d’identité. Utilisé avec file-oidc le type d’authentification. DATABRICKS_OIDC_TOKEN_FILEPATH oidc_token_filepath oidc_token_filepath (Python)
setOIDCTokenFilepath (Java)
OIDCTokenFilepath (Allez)

Types d’authentification pris en charge

Les valeurs du champ du type d’authentification Databricks prises en charge sont les suivantes :