Partager via

Authentification unifiée du client Databricks

L’authentification unifiée du client Databricks centralise la configuration et l’automatisation de l’authentification auprès d’Azure Databricks dans le cadre de l’autorisation OAuth. Elle vous permet de configurer une fois l’authentification Databricks, puis d’utiliser cette configuration sur plusieurs outils Databricks et kits de développement logiciel sans modifier la configuration de l’authentification.

Outils et kits de développement logiciel (SDK) participants

Les outils Databricks et les kits de développement logiciel (SDK) participants sont les suivants :

Tous les outils et kits SDK participants acceptent les variables d’environnement spéciales et les profils de configuration Azure Databricks pour l’authentification. Le fournisseur Databricks Terraform et les Kits de développement logiciel (SDK) Databricks pour Python, Java et Go acceptent également la configuration directe des paramètres d’authentification au sein du code. Pour plus d’informations, consultez les outils de développement local pour la documentation de l’outil ou du Kit de développement logiciel (SDK).

Méthodes par défaut pour l’authentification unifiée du client

Chaque fois qu’un outil ou un Kit de développement logiciel (SDK) doit autoriser l’accès à Azure Databricks, il tente les types d’authentification suivants dans l’ordre suivant par défaut. Lorsque l’outil ou le kit de développement logiciel (SDK) réussit avec le type d’authentification qu’il tente, il cesse de tenter de s’authentifier avec les autres types d’authentification. Pour forcer un SDK à s’authentifier avec un type d’authentification spécifique, définissez le champ de type d’authentification Databricks de l’API Config .

  1. Authentification à l’aide d’un jeton d’accès personnel Azure Databricks
  2. Autoriser l’accès sans intervention aux ressources Azure Databricks avec un principal de service utilisant OAuth
  3. Autoriser l’accès interactif aux ressources Azure Databricks avec un compte d’utilisateur à l’aide d’OAuth
  4. Authentification par identités managées Azure
  5. Authentification du principal de service MS Entra
  6. Authentification Azure CLI

Pour chaque type d’authentification que l’outil ou le kit de développement logiciel (SDK) participant essaye, celui-ci tente de trouver les informations d’authentification aux emplacements et dans l’ordre suivants. Lorsque l’outil ou le kit de développement logiciel (SDK) parvient à trouver les informations d’authentification qui peuvent être utilisées, il cesse d’essayer de trouver les informations d’authentification dans les emplacements restants.

  1. Champs d’API liés aux Config informations d’identification (pour les SDK). Pour définir des Config champs, consultez la documentation de référence du Kit de développement logiciel (SDK).
  2. Variables d’environnement liées aux informations d’identification.
  3. Champs liés aux informations d’identification dans le profil de configuration DEFAULT dans le fichier .databrickscfg. Pour définir des champs de profil de configuration, consultez (/dev-tools/auth/config-profiles.md).
  4. Toutes les informations d’authentification associées mises en cache par Azure CLI. Consultez Authentification Azure CLI.

Pour fournir une portabilité maximale pour votre code, Databricks vous recommande de créer un profil de configuration personnalisé dans le .databrickscfg fichier, d’ajouter les champs requis ci-dessous pour votre type d’authentification Databricks cible au profil de configuration personnalisé, puis de définir la DATABRICKS_CONFIG_PROFILE variable d’environnement sur le nom du profil de configuration personnalisé.

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

Les tableaux suivants répertorient les noms et les descriptions des variables et champs d’environnement pris en charge pour l’authentification unifiée du client Databricks. Dans les tableaux suivants :

  • Variable d’environnement, le cas échéant, est le nom de la variable d’environnement.
  • .databrickscfg le champ, le cas échéant, est le nom du champ dans un fichier de profils de configuration Azure Databricks. Pour définir des champs .databrickscfg, consultez Profils de configuration Azure Databricks.
  • Champ Terraform, le cas échéant, est le nom du champ dans une configuration Terraform Databricks. Pour définir des champs Terraform Databricks, consultez la section Authentification dans la documentation du fournisseur Databricks Terraform.
  • ConfigChamp est le nom du champ dans l’ API Config pour le kit de développement logiciel (SDK) spécifié.

Variables et champs d’environnement d’hôte, de jeton et d’ID de compte généraux

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)

Variables et champs d’environnement spécifiques à Azure

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 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 et variables d’environnement 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 (Chaîne) Un chemin non par défaut vers le
fichier .databrickscfg.		 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)

Champ type d’authentification

Utilisez cette variable d’environnement ou ce champ pour forcer un kit de développement logiciel (SDK) à utiliser 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. DATABRICKS_AUTH_TYPE auth_type auth_type (Python)
setAuthType (Java)
AuthType (Allez)

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

  • azure-msi: Définissez cette valeur si vous utilisez une identité de service managé Azure (MSI). Pour plus d’informations, consultez l’authentification des identités managées Azure.
  • azure-client-secret: Définissez cette valeur si vous utilisez un principal de service Azure avec des secrets client. Pour plus de détails, consultez Authentification du principal du service MS Entra.