Configurer l’autorisation pour l’extension Databricks pour Visual Studio Code

Cet article explique comment configurer l'autorisation et l'authentification entre l'extension Databricks pour Visual Studio Code et votre espace de travail Azure Databricks si vous n'avez pas déjà configuré l'extension via la configuration du projet. Consultez l’extension Databricks pour Visual Studio Code.

L’extension Databricks pour Visual Studio Code implémente des parties de l’authentification unifiée Databricks standard, ce qui vous permet de configurer Azure Databricks autorisation basée sur OAuth 2.0 une fois, puis d’utiliser cette configuration sur plusieurs Azure Databricks outils et kits SDK sans modification supplémentaire de la configuration de l’autorisation et de l’authentification. Il fournit également des actualisations automatiques des jetons d’accès actifs, ce qui réduit la complexité de votre processus lors du développement.

Databricks recommande l’autorisation utilisateur interactive OAuth, qui est facile à configurer à l’aide de l’extension Databricks pour Visual Studio Code. Consultez Configurer l’autorisation et l’authentification OAuth.

Sinon, si vous utilisez l'authentification avec des jetons d'accès personnel d'Azure Databricks (ancien), autorisez l'accès au compte de service à Azure Databricks avec OAuth, ou l'authentification avec des comptes de service Microsoft Entra, consultez Configurer l’authentification avec un profil de configuration. Pour Authenticate avec le Azure CLI, consultez Configurer l’authentification Azure CLI.

Remarque

L’extension Databricks pour Visual Studio Code ne prend pas en charge l’authentification à l’aide d’identités managées Azure (anciennement Azure MSI), mais Databricks Connect utilisée sans l’extension Databricks pour Visual Studio Code le fait. Pour installer Databricks Connect, consultez Installer Databricks Connect pour Python.

configurer l’autorisation et l’authentification OAuth

Azure Databricks prend en charge l’autorisation et l’authentification basées sur OAuth 2.0 et simplifie la gestion des jetons d’accès avec l’authentification unifiée Databricks unifiée. Pour plus d’informations sur l’autorisation d’utilisateur et de principal de service avec Azure Databricks, consultez Autoriser l’accès aux ressources Azure Databricks.

Pour terminer la configuration de l’autorisation OAuth, ouvrez votre projet VSCode avec l’extension Databricks pour Visual Studio Code activée :

  1. Dans la vue Configuration, cliquez sur Type d’authentification, puis sur l’icône d’engrenage (Se connecter à l’espace de travail Databricks).

    Se connecter à l’espace de travail Databricks

  2. Si vous disposez déjà d’un profil de configuration d’authentification dans cette liste avec l’étiquette S’authentifier à l’aide de l’étiquette OAuth (Utilisateur à machine) et que vous savez qu’il correspond à l’hôte Databricks cible, sélectionnez-le dans la liste, puis procédez comme suit :

    1. Si vous y êtes invité, suivez les instructions à l’écran dans votre navigateur web pour terminer l’authentification avec Azure Databricks.
    2. Si vous êtes également invité à le faire, autorisez l'accès à all-apis.
    3. Passez à l’étape Sélectionner le calcul pour l’exécution du code et des travaux.
  3. Dans la palette de commandes, pour Sélectionner la méthode d’authentification, cliquez sur OAuth (Utilisateur à machine).

  4. Pour Sélectionner la méthode d’authentification, sélectionnez OAuth (Utilisateur à machine).

  5. Entrez un nom pour le profil d’authentification Azure Databricks associé.

  6. Dans la vue Configuration, cliquez sur Se connecter à Databricks.

    Se connecter à Databricks

  7. Dans la palette de commandes, pour Sélectionner la méthode d’authentification, sélectionnez le nom du profil de configuration d’authentification que vous venez de créer.

  8. Si vous y êtes invité, suivez les instructions à l’écran dans votre navigateur web pour terminer l’authentification avec Azure Databricks. Si vous êtes également invité à le faire, autorisez l'accès à all-apis.

  9. Une fois connecté, revenez à Visual Studio Code.

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. Pour créer un profil, consultez Azure Databricks profils de configuration. Pour configurer les paramètres du profil, consultez l’onglet ou la section Profile pour votre type d’authentification dans Authorize l’accès aux ressources Azure Databricks.

Pour sélectionner le profil de configuration que vous souhaitez que l’extension utilise, avec votre projet et l’extension ouverte, procédez comme suit :

  1. Dans la vue Configuration, cliquez sur Type d’authentification, puis sur l’icône d’engrenage (Se connecter à l’espace de travail Databricks).

    Se connecter à l’espace de travail Databricks

  2. Dans la Command Palette, sélectionnez votre profil de configuration Azure Databricks cible dans la liste.

    Conseil

    L’hôte de l’espace de travail cible peut être modifié ultérieurement en modifiant le paramètre cible workspace dans le fichier de configuration databricks.yml associé au projet. Voir les cibles.

Si vous n’avez pas de profil de configuration, vous pouvez en créer un qui s’authentifie à l’aide d’un jeton d’accès personnel Azure Databricks, par exemple :

  1. Lorsque votre projet et l’extension s’ouvrent, dans la vue Configuration, cliquez sur Type d’authentification ou Se connecter à Databricks, puis sur l’icône d’engrenage (Se connecter à l’espace de travail Databricks).

    Se connecter à l’espace de travail Databricks

  2. Dans la palette de commandes, sélectionnez Jeton d’accès personnel.

  3. Répondez aux invites qui s’affichent à l’écran pour effectuer ce qui suit :

    1. Entrez un nom pour le profil d’authentification Azure Databricks associé.
    2. Générez le jeton d'accès personnel dans votre espace de travail Azure Databricks, puis copiez la valeur du jeton.
    3. Revenez à l’extension et entrez la valeur du jeton copié.

L’extension crée un dossier dans votre projet nommé .databricks avec un fichier nommé databricks.env, s’il n’existe pas déjà. Ce fichier contient l’hôte de l’espace de travail que vous avez entré, ainsi que d’autres détails de configuration Azure Databricks utilisés par 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.

Configurer l’authentification Azure CLI

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

Une fois votre projet et l’extension ouverte, et le Azure CLI installé localement, procédez comme suit :

  1. Dans la vue Configuration, cliquez sur Configurer Databricks.

    Remarque

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

    Icône en forme de roue dentée permettant de configurer les paramètres de l’espace de travail 1

  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.