Konfigurationsprofile für die Databricks-CLI

  • Artikel

Hinweis

Diese Informationen gelten für Databricks CLI-Versionen 0.205 und höher. Die Databricks CLI befindet sich in der öffentlichen Vorschau.

Die Verwendung von Databricks CLI unterliegt der Datenbricks-Lizenz - und Databricks-Datenschutzerklärung, einschließlich der Bestimmungen zu Nutzungsdaten.

In diesem Artikel wird beschrieben, wie Sie die Authentifizierung zwischen der Databricks-CLI und Ihren Azure Databricks-Konten und -Arbeitsbereichen einrichten. Weitere Informationen finden Sie unter Was ist die Databricks-CLI?.

In diesem Artikel wird davon ausgegangen, dass Sie die Databricks-CLI bereits installiert und für die Authentifizierung eingerichtet haben. Thema

Abrufen von Informationen zu Konfigurationsprofilen

Wenn Sie der .databrickscfg-Datei mehrere Konfigurationsprofile hinzufügen, können Sie Befehle schnell für verschiedene Arbeitsbereiche ausführen, indem Sie den Namen des Zielkonfigurationsprofils in der --profile-Option oder -p-Option der Befehle angeben, die diese Option unterstützen. Wenn Sie die Option --profile oder -p nicht in einem Befehl angeben, der diese Option unterstützt, verwendet der Befehl standardmäßig das DEFAULT-Konfigurationsprofil.

Tipp

Sie können Tab nach --profile oder -p drücken, um eine Liste der vorhandenen verfügbaren Konfigurationsprofile anzuzeigen, aus der Sie auswählen können, anstatt den Namen des Konfigurationsprofils manuell einzugeben.

Beispielsweise könnten Sie ein Konfigurationsprofil namens DEV haben, das auf einen Azure Databricks-Arbeitsbereich verweist, den Sie für Entwicklungsworkloads verwenden, und ein separates Konfigurationsprofil namens PROD, das auf einen anderen Azure Databricks-Arbeitsbereich verweist, den Sie für Produktionsworkloads verwenden.

Standardmäßig sucht die Databricks CLI nach der .databrickscfg-Datei in Ihrem ~-Ordner (Ihre Benutzerstartseite) unter Unix, Linux oder macOS oder in Ihrem %USERPROFILE%-Ordner (Ihre Benutzerstartseite) unter Windows. Sie können den Standardpfad der .databrickscfg-Datei ändern, indem Sie die Umgebungsvariable DATABRICKS_CONFIG_FILE festlegen. Informationen zum Festlegen von Umgebungsvariablen finden Sie in der Dokumentation Ihres Betriebssystems.

Führen Sie den auth env-Befehl aus, um Informationen zu einem vorhandenen Konfigurationsprofil abzurufen:

databricks auth env --profile <configuration-profile-name>

# Or:
databricks auth env --host <account-console-url>

# Or:
databricks auth env --host <workspace-url>

Hier sehen Sie beispielsweise die Ausgabe für ein Profil, das mit der Authentifizierung mit persönlichem Azure Databricks-Zugriffstoken konfiguriert ist:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "<configuration-profile-name>",
    "DATABRICKS_HOST": "<workspace-url>",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

Führen Sie den Befehl auth profiles aus, um Informationen zu allen verfügbaren Profilen abzurufen:

databricks auth profiles

Ausgabe (die Auslassungspunkte stellen aus Gründen der Kürze den ausgelassenen Inhalt dar):

{
  "profiles": [
    {
      "name": "<configuration-profile-name>",
      "host": "<workspace-url>",
      "cloud": "<cloud-id>",
      "auth_type": "<auth-type>",
      "valid": true
    },
    {
      "...": "..."
    }
  ]
}

Die Ausgabe des auth profiles-Befehls zeigt keine Zugriffstoken an. Um ein Zugriffstoken anzuzeigen, führen Sie den vorherigen Befehl auth env aus.

Wichtig

Die Databricks CLI kann nicht mit einer NETRC-Datei verwendet werden. Sie können eine .netrc-Datei in Ihrer Umgebung für andere Zwecke verwenden, aber die Databricks CLI verwendet diese .netrc-Datei nicht.

Testen des Setups des DEFAULT-Konfigurationsprofils

Um zu überprüfen, ob Sie die Authentifizierung richtig eingerichtet haben, können Sie einen Befehl wie den folgenden ausführen, der die verfügbaren Databricks Runtime-Versionen für den Azure Databricks-Arbeitsbereich auflistet, der Ihrem DEFAULT-Profil zugeordnet ist.

Beim folgenden Aufruf wird davon ausgegangen, dass Sie keine speziellen Umgebungsvariablen festgelegt haben, die Vorrang vor den Einstellungen in Ihrem DEFAULT-Profil haben. Weitere Informationen finden Sie unter Authentifizierungsreihenfolge der Auswertung.

databricks clusters spark-versions

Testen Ihres Konfigurationsprofils

Um zu überprüfen, ob Sie Konfigurationsprofile ordnungsgemäß eingerichtet haben, können Sie einen Befehl wie den folgenden mit einem Ihrer Konfigurationsprofilnamen auf Arbeitsbereichsebene ausführen: Dieser Befehl listet die verfügbaren Databricks Runtime-Versionen für den Azure Databricks-Arbeitsbereich auf, der dem angegebenen Konfigurationsprofil zugeordnet ist, das hier durch den Platzhalter <configuration-profile-name> dargestellt wird:

databricks clusters spark-versions -p <configuration-profile-name>

Tipp

Sie können Tab nach --profile oder -p drücken, um eine Liste der vorhandenen verfügbaren Konfigurationsprofile anzuzeigen, aus der Sie auswählen können, anstatt den Namen des Konfigurationsprofils manuell einzugeben.

Führen Sie den folgenden Befehl aus, um Details für ein bestimmtes Profil aufzulisten:

databricks auth env --profile <configuration-profile-name>

Führen Sie den folgenden Befehl aus, um Details für alle verfügbaren Profile aufzulisten:

databricks auth profiles