Variables d'environnement et champs 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 sur la CLI Databricks, le fournisseur Terraform et les 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 comprend :

• Variable d'environnement : définissez-la dans votre environnement shell.
• Champ.databrickscfg : Utilisez-le dans les profils de configuration.
• Champ Terraform : configurez ceci dans votre bloc de fournisseur Terraform. Voir l'authentification dans la documentation du fournisseur Databricks Terraform.
• Config **Champ :** Utilisez ce champ lors de la configuration des SDK de manière programmatique avec Config l'API.

Champs de configuration générale

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

Nom commun	Description	Variable d'environnement	.databrickscfg champ, champ Terraform	Config champ
Hôte Databricks	(Chaîne) L'URL d'hôte Databricks pour le Endpoint du Workspace Databricks ou le Endpoint des comptes Databricks.	DATABRICKS_HOST	host	host (Python) setHost (Java) Host (Aller)
Jeton Databricks	(Chaîne) Le jeton d'accès personnel Databricks.	DATABRICKS_TOKEN	token	token (Python) setToken (Java) Token (Aller)
ID de compte Databricks	(Chaîne) L'ID de compte Databricks pour l'Endpoint du compte Databricks. N'a d'effet que lorsque l'hôte Databricks est également défini sur https://accounts.cloud.databricks.com.	DATABRICKS_ACCOUNT_ID	account_id	account_id (Python) setAccountID (Java) AccountID (Aller)
ID de cluster	(Chaîne) L'identifiant du cluster à utiliser	DATABRICKS_CLUSTER_ID	cluster_id	cluster_id
Compute serverless	(String) Le paramètre d'activation automatique du compute serverless. Les valeurs valides sont auto.	DATABRICKS_SERVERLESS_COMPUTE_ID	serverless_compute_id	serverless_compute_id

Nom commun	Description	Variable d'environnement	.databrickscfg champ, champ Terraform	Config champ
Hôte Databricks	(Chaîne) L'URL d'hôte Databricks pour le Endpoint du Workspace Databricks ou le Endpoint des comptes Databricks.	DATABRICKS_HOST	host	host (Python) setHost (Java) Host (Aller)
Jeton Databricks	(Chaîne) Le jeton d'accès personnel Databricks.	DATABRICKS_TOKEN	token	token (Python) setToken (Java) Token (Aller)
ID de compte Databricks	(Chaîne) L'ID de compte Databricks pour l'Endpoint du compte Databricks. N'a d'effet que lorsque l'hôte Databricks est également défini sur https://accounts.cloud.databricks.com.	DATABRICKS_ACCOUNT_ID	account_id	account_id (Python) setAccountID (Java) AccountID (Aller)
ID de cluster	(Chaîne) L'identifiant du cluster à utiliser	DATABRICKS_CLUSTER_ID	cluster_id	cluster_id
Compute serverless	(String) Le paramètre d'activation automatique du compute serverless. Les valeurs valides sont auto.	DATABRICKS_SERVERLESS_COMPUTE_ID	serverless_compute_id	serverless_compute_id

Champs d'utilisateur et de Service Principal

Ces variables configurent l'authentification avec les noms d'utilisateur Databricks et les Service Principal.

Nom commun	Description	Variable d'environnement	.databrickscfg champ, champ Terraform	Config champ
Nom d'utilisateur Databricks	(String) Le nom d'utilisateur de l'utilisateur Databricks.	DATABRICKS_USERNAME	username	username (Python) setUsername (Java) Username (Aller)
ID client du Service Principal	(String) L'ID client du Service Principal Databricks.	DATABRICKS_CLIENT_ID	client_id	client_id (Python) setClientId (Java) ClientId (Aller)
Secret de Service Principal	(Chaîne de caractères) Le secret du service principal Databricks.	DATABRICKS_CLIENT_SECRET	client_secret	client_secret (Python) setClientSecret (Java) ClientSecret (Aller)

Nom commun	Description	Variable d'environnement	.databrickscfg champ, champ Terraform	Config champ
Nom d'utilisateur Databricks	(String) Le nom d'utilisateur de l'utilisateur Databricks.	DATABRICKS_USERNAME	username	username (Python) setUsername (Java) Username (Aller)
ID client du Service Principal	(String) L'ID client du Service Principal Databricks.	DATABRICKS_CLIENT_ID	client_id	client_id (Python) setClientId (Java) ClientId (Aller)
Secret de Service Principal	(Chaîne de caractères) Le secret du service principal Databricks.	DATABRICKS_CLIENT_SECRET	client_secret	client_secret (Python) setClientSecret (Java) ClientSecret (Aller)

Champs spécifiques à .databrickscfg

Utilisez ces variables d'environnement ou ces champs pour spécifier des paramètres non-default pour .databrickscfg. Voir aussi profils de configuration Databricks.

Nom commun	Description	Variable d'environnement	Champ Terraform	Config champ
.databrickscfg Chemin d'accès au fichier	(Chaîne) Chemin non default vers le fichier .databrickscfg.	DATABRICKS_CONFIG_FILE	config_file	config_file (Python) setConfigFile (Java) ConfigFile (Aller)
.databrickscfg profil default	(Chaîne) Le profil nommé par default à utiliser, autre que DEFAULT.	DATABRICKS_CONFIG_PROFILE	profile	profile (Python) setProfile (Java) Profile (Aller)

Nom commun	Description	Variable d'environnement	Champ Terraform	Config champ
.databrickscfg Chemin d'accès au fichier	(Chaîne) Chemin non default vers le fichier .databrickscfg.	DATABRICKS_CONFIG_FILE	config_file	config_file (Python) setConfigFile (Java) ConfigFile (Aller)
.databrickscfg profil default	(Chaîne) Le profil nommé par default à utiliser, autre que DEFAULT.	DATABRICKS_CONFIG_PROFILE	profile	profile (Python) setProfile (Java) Profile (Aller)

Champs d'authentification

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

Nom commun	Description	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. Voir Types d'authentification pris en charge.	DATABRICKS_AUTH_TYPE	auth_type	auth_type (Python) setAuthType (Java) AuthType (Aller)
Variable d'environnement du jeton OIDC	(Chaîne) Le nom de la variable d'environnement qui contient votre jeton OIDC émis par l'IdP. Utilisé avec le type d'authentification env-oidc. Default sur DATABRICKS_OIDC_TOKEN.	DATABRICKS_OIDC_TOKEN_ENV	oidc_token_env	oidc_token_env (Python) setOIDCTokenEnv (Java) OIDCTokenEnv (Aller)
Chemin du fichier de jeton OIDC	(Chaîne) Le chemin d'accès à un fichier local qui contient votre jeton OIDC émis par l'IdP. Utilisé avec le type d'authentification file-oidc.	DATABRICKS_OIDC_TOKEN_FILEPATH	oidc_token_filepath	oidc_token_filepath (Python) setOIDCTokenFilepath (Java) OIDCTokenFilepath (Aller)

Nom commun	Description	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. Voir Types d'authentification pris en charge.	DATABRICKS_AUTH_TYPE	auth_type	auth_type (Python) setAuthType (Java) AuthType (Aller)
Variable d'environnement du jeton OIDC	(Chaîne) Le nom de la variable d'environnement qui contient votre jeton OIDC émis par l'IdP. Utilisé avec le type d'authentification env-oidc. Default sur DATABRICKS_OIDC_TOKEN.	DATABRICKS_OIDC_TOKEN_ENV	oidc_token_env	oidc_token_env (Python) setOIDCTokenEnv (Java) OIDCTokenEnv (Aller)
Chemin du fichier de jeton OIDC	(Chaîne) Le chemin d'accès à un fichier local qui contient votre jeton OIDC émis par l'IdP. Utilisé avec le type d'authentification file-oidc.	DATABRICKS_OIDC_TOKEN_FILEPATH	oidc_token_filepath	oidc_token_filepath (Python) setOIDCTokenFilepath (Java) OIDCTokenFilepath (Aller)

Types d'authentification pris en charge

Les valeurs de champ de type d'authentification Databricks prises en charge incluent :

• oauth-m2m** :** pour l'authentification machine-à-machine (M2M) avec un Service Principal Databricks via OAuth 2.0. Consultez Autoriser l'accès du Service Principal à Databricks avec OAuth.
• pat: Pour l'authentification à l'aide d'un jeton d'accès personnel Databricks. Consultez S'authentifier avec des jetons d'accès personnels Databricks (hérité).
• databricks-cli: Pour la connexion interactive avec la CLI Databricks en utilisant OAuth 2.0. Consultez Autoriser l'accès utilisateur à Databricks avec OAuth.
• oidc-token: Pour la fédération de jetons avec un fournisseur d'identité (IdP), où Databricks échange un jeton OIDC émis par un IdP contre un jeton OAuth Databricks. Consultez Authentification avec un jeton de fournisseur d’identité.
• env-oidc** :** Pour la fédération lorsque votre jeton IdP est stocké dans une variable d'environnementDATABRICKS_OIDC_TOKEN (). Consultez S'authentifier avec un jeton de fournisseur d'identité.
• file-oidc: Pour la fédération lorsque votre jeton de fournisseur d'identité est stocké dans un fichier local (DATABRICKS_OIDC_TOKEN_FILEPATH). Consultez S'authentifier avec un jeton de fournisseur d'identité.
• github-oidc: Pour l'authentification fédérée GitHub Actions via des jetons OIDC. Consultez Activer la fédération d'identité de charge de travail pour GitHub Actions.
• azure-devops-oidc** :** Pour l'authentification fédérée Azure DevOps via des jetons OIDC. Consultez Activer la fédération d'identité de charge de travail pour les pipelines Azure DevOps.