Einrichten der Autorisierung für die Databricks-Erweiterung für Visual Studio Code

In diesem Artikel wird beschrieben, wie Sie die Autorisierung und Authentifizierung zwischen der Databricks-Erweiterung für Visual Studio Code und Ihrem Azure Databricks Arbeitsbereich einrichten, wenn Sie die Erweiterung noch nicht über die Projekteinrichtung konfiguriert haben. Siehe Databricks-Erweiterung für Visual Studio Code.

Die Databricks-Erweiterung für Visual Studio Code implementiert Teile der Databricks unified authentication Standard. Diese ermöglicht es, die Azure Databricks OAuth 2.0-basierte Autorisierung einmal zu konfigurieren und diese Konfiguration dann für mehrere Azure Databricks-Tools und -SDKs ohne weitere Änderungen der Autorisierungs- und Authentifizierungskonfiguration zu verwenden. Außerdem werden automatische Aktualisierungen aktiver Zugriffstoken bereitgestellt, wodurch die Prozesskomplexität bei der Entwicklung reduziert wird.

Databricks empfiehlt OAuth interaktive Benutzerautorisierung, die einfach mit der Databricks-Erweiterung für Visual Studio Code konfiguriert werden kann. Weitere Informationen finden Sie unter Einrichten von OAuth-Autorisierungs- und Authentifizierung.

Andernfalls, wenn Sie die Authentifizierung mit Azure Databricks-Personenzugriffstokens (Legacy), den Zugriff des Dienstprinzipals auf Azure Databricks mit OAuth autorisieren oder die Authentifizierung mit Microsoft Entra-Dienstprinzipalen verwenden, finden Sie weitere Informationen unter Authentifizierung mit einem Konfigurationsprofil einrichten. Informationen zum Authenticate mit dem Azure CLI finden Sie unter Set up Azure CLI authentication.

Einrichten der OAuth-Autorisierung und -Authentifizierung

Azure Databricks unterstützt OAuth 2.0-basierte Autorisierung und Authentifizierung und vereinfacht die Verwaltung von Zugriffstoken mit Databricks unified authentication. Weitere Informationen zur Benutzer- und Dienstprinzipalautorisierung mit Azure Databricks finden Sie unter Authorize access to Azure Databricks resources.

Um das Setup für die OAuth-Autorisierung abzuschließen, öffnen Sie Ihr VSCode-Projekt mit der Databricks-Erweiterung für Visual Studio Code aktiviert:

1. Klicken Sie in der Ansicht Konfiguration auf Authentifizierungstyp und dann auf das Zahnradsymbol (Bei Databricks-Arbeitsbereich anmelden).

   

2. Wenn Sie in dieser Liste bereits ein Konfigurationsprofil mit der Bezeichnung Authentifizierung mit OAuth (U2M) haben und wissen, dass es dem Databricks-Zielhost entspricht, wählen Sie es aus der Liste aus und gehen Sie dann folgendermaßen vor:

   1. Wenn Sie dazu aufgefordert werden, schließen Sie alle Anweisungen auf dem Bildschirm in Ihrem Webbrowser ab, um die Authentifizierung mit Azure Databricks abzuschließen.
   2. Wenn Sie dazu aufgefordert werden, erlauben Sie auch den all-apis-Zugriff.
   3. Fahren Sie fort, um die Berechnung für die Ausführung von Code und Aufträgen auszuwählen.

3. Klicken Sie in der Befehlspalette auf OAuth (user to machine) für Authentifizierungsmethode auswählen.

4. Wählen Sie für Authentifizierungsmethode auswählen die Option OAuth (user to machine).

5. Geben Sie einen Namen für das zugeordnete Azure Databricks Authentifizierungsprofil ein.

6. Klicken Sie in der Ansicht Konfiguration auf Bei Databricks anmelden.

   

7. Wählen Sie in der Befehlspalette für Authentifizierungsmethode auswählen den Namen des soeben erstellten Konfigurationsprofils für die Authentifizierung aus.

8. Wenn Sie dazu aufgefordert werden, schließen Sie alle Anweisungen auf dem Bildschirm in Ihrem Webbrowser ab, um die Authentifizierung mit Azure Databricks abzuschließen. Wenn Sie dazu aufgefordert werden, erlauben Sie auch den all-apis-Zugriff.

9. Nachdem Sie sich erfolgreich angemeldet haben, kehren Sie zu Visual Studio Code zurück.

Einrichten der Authentifizierung mit einem Konfigurationsprofil

In den folgenden Anweisungen wird davon ausgegangen, dass Sie bereits ein Azure Databricks Konfigurationsprofil mit den erforderlichen Feldern für Ihren Azure Databricks Authentifizierungstyp eingerichtet haben. Informationen zum Erstellen eines Profils finden Sie unter Azure Databricks Konfigurationsprofile. Informationen zum Konfigurieren von Einstellungen für das Profil finden Sie auf der Registerkarte Profile für Ihren Authentifizierungstyp in Authorize access to Azure Databricks resources.

Gehen Sie zum Auswählen des von der Erweiterung zu verwendenden Konfigurationsprofils bei geöffnetem Projekt und geöffneter Erweiterung folgendermaßen vor:

1. Klicken Sie in der Ansicht Konfiguration auf Authentifizierungstyp und dann auf das Zahnradsymbol (Bei Databricks-Arbeitsbereich anmelden).

   

2. Wählen Sie in der Command Palette Ihr Ziel-Azure-Databricks-Konfigurationsprofil aus der Liste aus.

   Tipp

   Der Host des Zielarbeitsbereichs kann später geändert werden, indem die Ziel-Einstellung workspace in der zum Projekt gehörenden Konfigurationsdatei databricks.yml angepasst wird. Siehe Ziele.

Wenn Sie nicht über ein Konfigurationsprofil verfügen, können Sie ein Profil erstellen, das sich mithilfe eines Azure Databricks persönlichen Zugriffstokens authentifiziert, z. B. wie folgt:

1. Klicken Sie bei geöffnetem Projekt und geöffneter Erweiterung in der Ansicht Konfiguration auf Authentifizierungstyp oder Anmelden bei Databricks und anschließend auf das Zahnradsymbol (Bei Databricks-Arbeitsbereich anmelden).

   

2. Wählen Sie in der Befehlspalette die Option Persönliches Zugriffstoken aus.

3. Befolgen Sie die angezeigten Eingabeaufforderungen für Folgendes:

   1. Geben Sie einen Namen für das zugeordnete Azure Databricks Authentifizierungsprofil ein.
   2. Generieren Sie das persönliche Zugriffstoken in Ihrem Azure Databricks Arbeitsbereich, und kopieren Sie dann den Wert des Tokens.
   3. Kehren Sie zur Erweiterung zurück, und geben Sie den Wert des kopierten Tokens ein.

Die Erweiterung erstellt in Ihrem Projekt einen Ordner mit dem Namen .databricks und eine Datei mit dem Namen databricks.env, falls sie nicht bereits existiert. Diese Datei enthält den von Ihnen eingegebenen Arbeitsbereichshost sowie weitere Azure Databricks Konfigurationsdetails, die von der Databricks-Erweiterung für Visual Studio Code verwendet werden.

Durch die Erweiterung wird dem Projekt auch eine ausgeblendete .gitignore-Datei hinzugefügt, wenn die Datei nicht vorhanden ist oder eine vorhandene .gitignore-Datei in keinem der übergeordneten Ordnern gefunden wird. Wenn eine neue .gitignore-Datei erstellt wird, fügt die Erweiterung dieser neuen Datei einen .databricks/-Eintrag hinzu. Wenn die Erweiterung eine vorhandene .gitignore-Datei findet, fügt sie der vorhandenen Datei einen .databricks/-Eintrag hinzu.

Azure CLI-Authentifizierung einrichten

Azure Databricks unterstützt die Authentifizierung mit der lokal installierten Azure CLI. Auf diese Weise können Sie auf eine Stunde begrenzte Microsoft Entra ID Token generieren, wodurch das Risiko verringert wird, durch die versehentliche Offenlegung von längerlebigen Token wie Azure-Databricks-Persönliche-Zugriffstoken über Versionierungs-Check-ins oder andere Mittel verfügbar zu machen.

Führen Sie mit dem geöffneten Projekt und der geöffneten Erweiterung und dem lokal installierten Azure CLI die folgenden Schritte aus:

1. Klicken Sie in der Ansicht Konfiguration auf Databricks konfigurieren.

   Hinweis

   Wenn Databricks konfigurieren nicht angezeigt wird, klicken Sie stattdessen auf das Zahnradsymbol (Arbeitsbereich konfigurieren) neben Konfiguration.

   

2. Geben Sie in der Befehlspalette als Databricks-Host Ihre arbeitsbereichsspezifische URL ein, z. B https://adb-1234567890123456.7.azuredatabricks.net. Betätigen Sie anschließend die Eingabetaste.

3. Wählen Sie Azure CLI aus.