Configuration de l’authentification pour l’extension Databricks pour VS Code

Cet article explique comment configurer l’authentification entre l’extension Databricks pour Visual Studio Code et votre espace de travail Azure Databricks. Consultez Qu’est-ce que l’extension Databricks pour Visual Studio Code ?

L’extension Databricks pour Visual Studio Code implémente des parties de l’authentification unifiée du client Databricks standard, une approche architecturale et programmatique consolidée et cohérente pour l’authentification. Cette approche permet de rendre la configuration et l’automatisation de l’authentification avec Azure Databricks plus centralisées et prévisibles. Elle vous permet de configurer une seule fois l’authentification Azure Databricks, puis d’utiliser cette configuration sur plusieurs outils Azure Databricks et SDK sans modifier à nouveau la configuration de l’authentification.

Ces informations supposent que vous avez déjà installé et configuré l’extension Databricks pour Visual Studio Code. Consultez Installer l’extension Databricks pour Visual Studio Code.

Remarque

Si vous avez déjà terminé le Didacticiel sur l’extension VSCode pour Databricks : exécuter Python sur un cluster et en tant que travail et que vous souhaitez continuer à utiliser l’authentification via jeton d'accès personnel Azure Databricks que vous avez configuré dans ce didacticiel, passez à Sélectionner un cluster pour l’extension Databricks pour Visual Studio Code.

En fonction du type d’authentification que vous souhaitez utiliser, suivez les instructions relatives au type d’authentification Azure Databricks cible.

• Si vous souhaitez en savoir plus sur les types d’authentification suivants, veuillez consulter la rubrique Configurer l’authentification avec un profil de configuration :
  • Authentification à l’aide d’un jeton d’accès personnel Azure Databricks
  • Authentification OAuth machine à machine (M2M)
  • Authentification du principal de service Microsoft Entra ID
• Pour l’Authentification utilisateur à machine (U2M) OAuth, passez à Configurer l’authentification U2M OAuth.
• Pour l’authentification Azure CLI, passez à Configurer l’authentification Azure CLI.

Remarque

L’extension Databricks pour Visual Studio Code ne prend pas encore en charge l’authentification à l’aide d’identités managées Azure (anciennement Azure Managed Service Identities (MSI)).

Databricks Connect prend en charge l’authentification à l’aide d’identités managées Azure. Toutefois, vous ne pouvez pas utiliser l’intégration Databricks Connect au sein de l’extension Databricks pour Visual Studio Code pour effectuer une authentification par identité managée Azure. Si vous souhaitez utiliser Databricks Connect avec Visual Studio Code par lui-même, indépendamment de l’extension Databricks pour Visual Studio Code, consultez Utiliser Visual Studio Code avec Databricks Connect pour Python.

Configurer l’authentification avec un profil de configuration

Les instructions suivantes supposent que vous avez déjà configuré un profil de configuration Azure Databricks avec les champs requis pour votre type d’authentification Azure Databricks. Si vous souhaitez en savoir plus, veuillez consulter la rubrique Profils de configuration Azure Databricks et l’onglet ou la section Profil de votre type d’authentification dans Authentification pour l’automatisation Azure Databricks - vue d’ensemble.

Par exemple, si vous souhaitez vous authentifier à l’aide de l’authentification par jeton d’accès personnel Azure Databricks, créez votre jeton d’accès personnel en procédant comme suit :

1. Dans votre espace de travail Azure Databricks, cliquez sur votre nom d’utilisateur Azure Databricks dans la barre supérieure, puis sélectionnez Paramètres dans la liste déroulante.
2. Cliquez sur Développeur.
3. À côté de Jetons d’accès, cliquez sur Gérer.
4. Cliquez sur Générer un nouveau jeton.
5. (Facultatif) Entrez un commentaire qui vous aide à identifier ce jeton à l’avenir et modifiez sa durée de vie par défaut (90 jours). Pour créer un jeton sans durée de vie (non recommandé), laissez vide la zone Durée de vie (en jours).
6. Cliquez sur Générer.
7. Copiez le jeton affiché dans un emplacement sécurisé, puis cliquez sur Terminé.

Remarque

Veillez à enregistrer le jeton copié dans un emplacement sécurisé. Ne partagez pas votre jeton copié avec d'autres. Si vous le perdez, vous ne pouvez pas régénérer exactement le même. Vous devez donc répéter cette procédure pour créer un jeton. Si vous perdez le jeton copié ou si vous pensez que le jeton a été compromis, Databricks vous recommande vivement de supprimer immédiatement ce jeton de votre espace de travail en cliquant sur l’icône de la corbeille (Révoquer) à côté du jeton de la page Jetons d’accès.

Si vous n'êtes pas en mesure de créer ou d'utiliser des jetons dans votre espace de travail, cela peut être dû au fait que votre administrateur d'espace de travail a désactivé les jetons ou ne vous a pas donné l'autorisation de créer ou d'utiliser des jetons. Consultez votre administrateur d'espace de travail ou les personnes suivantes :

• Activer ou désactiver l'authentification par jeton d'accès personnel pour l'espace de travail
• Autorisations de jeton d'accès personnel

Par exemple, pour créer un profil de configuration nommé DEFAULT pour votre jeton d’accès personnel, procédez comme suit :

Remarque

La procédure suivante utilise l’interface de ligne de commande (CLI) Databricks pour créer un profil de configuration Azure Databricks nommé DEFAULT. Si vous avez déjà un profil de configuration DEFAULT, cette procédure remplace votre profil de configuration DEFAULT existant.

Pour vérifier si vous avez déjà un profil de configuration DEFAULT et pour voir les paramètres de ce profil s’il existe, utilisez l’interface CLI Databricks pour exécuter la commande databricks auth env --profile DEFAULT.

Pour créer un profil de configuration avec un nom autre que DEFAULT, remplacez la partie DEFAULT de --profile DEFAULT dans la commande databricks configure suivante par un autre nom de profil de configuration.

1. Utilisez l’interface CLI Databricks pour créer un profil de configuration Azure Databricks nommé DEFAULT qui utilise l’authentification par jeton d’accès personnel Azure Databricks. Pour ce faire, exécutez la commande suivante :

   databricks configure --profile DEFAULT
   

2. Pour l’invite Databricks Host , entrez votre URL Azure Databricks par espace de travail, par exemple : https://adb-1234567890123456.7.azuredatabricks.net.

3. Pour l’invite Jeton d’accès personnel, entrez le jeton d’accès personnel Azure Databricks pour votre espace de travail.

Une fois que votre profil de configuration Azure Databricks est prêt, avec votre projet et l’extension ouverte, procédez comme suit :

1. Dans le volet Configuration, cliquez sur Configurer Databricks.

   Notes

   Si Configurer Databricks n’est pas visible, cliquez sur la roue dentée (Configurer l’espace de travail) en regard de Configuration.

   

2. Dans la palette de commandes, pour Databricks Host (Hôte Databricks), entrez votre URL par espace de travail, par exemple https://adb-1234567890123456.7.azuredatabricks.net. Appuyez sur Entrée.

3. Sélectionnez votre profil de configuration Azure Databricks cible dans la liste de l’URL.

L’extension crée un dossier masqué dans votre projet nommé .databricks, s’il n’existe pas déjà. L’extension crée également dans ce dossier un fichier nommé project.json, s’il n’existe pas déjà. Ce fichier contient l’URL que vous avez entrée, ainsi que les informations d’authentification Azure Databricks dont a besoin pour fonctionner l’extension Databricks pour Visual Studio Code.

L’extension ajoute également un fichier masqué .gitignore au projet si le fichier n’existe pas ou s’il est introuvable dans les .gitignore dossiers parents. Si un nouveau .gitignore fichier est créé, l’extension ajoute une .databricks/ entrée à ce nouveau fichier. Si l’extension trouve un fichier existant .gitignore , elle ajoute une .databricks/ entrée au fichier existant.

Continuez avec Sélectionner un cluster pour l’extension Databricks pour Visual Studio Code.

Configurer l’authentification OAuth U2M

Azure Databricks prend en charge l’authentification utilisateur à machine (U2M) OAuth. Cela vous permet de générer des jetons d’accès OAuth de courte durée (une heure), ce qui élimine le risque d’exposer accidentellement des jetons de durée de vie plus longue, tels que des jetons d’accès personnels Azure Databricks au travers de contrôles de version ou d’autres moyens. Cela permet également une meilleure invalidation des sessions et une étendue côté serveur.

Pour terminer la configuration de l’authentification U2M OAuth, une fois votre projet et l’extension ouverts, procédez comme suit :

1. Dans le volet Configuration, cliquez sur Configurer Databricks.

   Notes

   Si Configurer Databricks n’est pas visible, cliquez sur la roue dentée (Configurer l’espace de travail) en regard de Configuration.

   

2. Dans la palette de commandes, pour Databricks Host (Hôte Databricks), entrez votre URL par espace de travail, par exemple https://adb-1234567890123456.7.azuredatabricks.net. Appuyez sur Entrée.

3. Sélectionnez OAuth (utilisateur à machine).

4. Suivez les instructions à l’écran dans votre navigateur web pour terminer l’authentification avec votre compte Azure Databricks. Si vous y êtes invité, autorisez l’accès all-apis.

L’extension crée un dossier masqué dans votre projet nommé .databricks, s’il n’existe pas déjà. L’extension crée également dans ce dossier un fichier nommé project.json, s’il n’existe pas déjà. Ce fichier contient l’URL que vous avez entrée, ainsi que les informations d’authentification Azure Databricks dont a besoin pour fonctionner l’extension Databricks pour Visual Studio Code.

L’extension ajoute également un fichier masqué .gitignore au projet si le fichier n’existe pas ou s’il est introuvable dans les .gitignore dossiers parents. Si un nouveau .gitignore fichier est créé, l’extension ajoute une .databricks/ entrée à ce nouveau fichier. Si l’extension trouve un fichier existant .gitignore , elle ajoute une .databricks/ entrée au fichier existant.

Continuez avec Sélectionner un cluster pour l’extension Databricks pour Visual Studio Code.

Configurer l’authentification Azure CLI

Azure Databricks prend en charge l’authentification avec Azure CLI installé localement. Cette opération vous permet de générer des jetons Microsoft Entra ID (anciennement Azure Active Directory) de courte durée (une heure), ce qui élimine le risque d’exposer accidentellement des jetons de durée de vie plus longue, tels que des jetons d’accès personnels Azure Databricks via des contrôles de version ou d’autres moyens.

Une fois votre projet et l’extension ouverts, et azure CLI installé localement, procédez comme suit :

1. Dans le volet Configuration, cliquez sur Configurer Databricks.

   Notes

   Si Configurer Databricks n’est pas visible, cliquez sur la roue dentée (Configurer l’espace de travail) en regard de Configuration.

   

2. Dans la palette de commandes, pour Databricks Host (Hôte Databricks), entrez votre URL par espace de travail, par exemple https://adb-1234567890123456.7.azuredatabricks.net. Appuyez sur Entrée.

3. Sélectionnez Azure CLI.

L’extension crée un dossier masqué dans votre projet nommé .databricks, s’il n’existe pas déjà. L’extension crée également dans ce dossier un fichier nommé project.json, s’il n’existe pas déjà. Ce fichier contient l’URL que vous avez entrée, ainsi que les informations d’authentification Azure Databricks dont a besoin pour fonctionner l’extension Databricks pour Visual Studio Code.

L’extension ajoute également un fichier masqué .gitignore au projet si le fichier n’existe pas ou s’il est introuvable dans les .gitignore dossiers parents. Si un nouveau .gitignore fichier est créé, l’extension ajoute une .databricks/ entrée à ce nouveau fichier. Si l’extension trouve un fichier existant .gitignore , elle ajoute une .databricks/ entrée au fichier existant.

Continuez avec Sélectionner un cluster pour l’extension Databricks pour Visual Studio Code.