configure-Befehl

Note

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.

Mit configure dem Befehl in der Databricks CLI können Sie die Databricks CLI mit Azure Databricks mithilfe von Azure Databricks-Token für persönliche Zugriffstoken oder Microsoft Entra ID (früher Azure Active Directory)-Token authentifizieren.

Note

Als bewährte Sicherheitsmaßnahme empfiehlt Databricks, dass Sie bei der Authentifizierung mit automatisierten Tools, Systemen, Skripten und Apps persönliche Zugriffstoken von Dienstprinzipalen anstelle von Arbeitsbereichsbenutzern verwenden. Informationen zum Erstellen von Token für Dienstprinzipale finden Sie unter "Verwalten von Token für einen Dienstprinzipal".

Beachten Sie, dass in diesem Artikel nur Azure Databricks Personal Access Token und Microsoft Entra ID Token-Authentifizierung behandelt werden, um das Aufrufen von arbeitsbereichsebene Befehlen zu ermöglichen. Weitere Konfigurationsoptionen für die Authentifizierung finden Sie unter "Authentication for the Databricks CLI".

databricks configure

Konfigurieren Sie ein Profil in Ihrer ~/.databrickscfg Datei. Ein Konfigurationsprofil ist eine Sammlung von Einstellungen, die Authentifizierungsinformationen wie eine Azure Databricks-Arbeitsbereichs-URL und einen Zugriffstokenwert enthalten.

Ein Konfigurationsprofil verfügt über einen programmgesteuerten Namen, z. B. DEFAULT, DEV oder PROD. Wenn Sie der .databrickscfg Datei mehrere Profile hinzufügen, können Sie Befehle schnell in verschiedenen Arbeitsbereichen ausführen, indem Sie den Namen des Zielverbindungsprofils in der Option des --profile Befehls angeben. Wenn Sie die Option --profile nicht in einem Befehl angeben, der diese Option unterstützt, verwendet der Befehl standardmäßig das DEFAULT-Verbindungsprofil.

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

Verwenden Sie die auth Befehlsgruppe, um Informationen zu vorhandenen Konfigurationsprofilen abzurufen.

Sie können den Standardpfad der .databrickscfg Datei ändern, indem Sie die Umgebungsvariable DATABRICKS_CONFIG_FILEfestlegen.

Wenn dieser Befehl im nicht interaktiven Modus aufgerufen wird, liest er das Token aus stdin. Der Host muss mit dem --host Flag oder der DATABRICKS_HOST Umgebungsvariable angegeben werden.

databricks configure [flags]

Options

--configure-cluster

    Aufforderungen zum Konfigurieren des Clusters

--host string

    Host-URL des Databricks-Arbeitsbereichs

Die Host-URL des Arbeitsbereichs ist die arbeitsbereichsspezifische URL im Format https://adb-<workspace-id>.<random-number>.azuredatabricks.net. Informationen zum Abrufen der arbeitsbereichsspezifischen URL finden Sie unter URL pro Arbeitsbereich.

--profile string

    Name für das zu konfigurierende Verbindungsprofil. (Standardeinstellung "DEFAULT")

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird die Authentifizierung für das Standardprofil konfiguriert:

databricks configure

Im folgenden Beispiel wird die Authentifizierung für ein bestimmtes Profil konfiguriert:

databricks configure --profile my-profile

Im folgenden Beispiel wird die Authentifizierung mit einem bestimmten Host konfiguriert:

databricks configure --host https://my-workspace.cloud.databricks.com

Im folgenden Beispiel wird die Authentifizierung mit der Clusterkonfiguration konfiguriert:

databricks configure --configure-cluster

Globale Kennzeichnungen

--debug

  Gibt an, ob die Debugprotokollierung aktiviert werden soll.

-h oder --help

    Hilfe für die Databricks CLI oder die zugehörige Befehlsgruppe oder den zugehörigen Befehl anzeigen.

--log-file Schnur

    Eine Zeichenfolge, die die Datei darstellt, in die Ausgabeprotokolle geschrieben werden sollen. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle standardmäßig in stderr geschrieben.

--log-format Format

    Der Protokollformattyp text oder json. Der Standardwert ist text.

--log-level Schnur

    Eine Zeichenfolge, die die Protokollformatebene darstellt. Wenn nicht angegeben, ist die Protokollformatebene deaktiviert.

-o, --output Typ

    Der Befehlsausgabetyp text oder json. Der Standardwert ist text.

-p, --profile Schnur

    Der Name des Profils in der ~/.databrickscfg Datei, das zum Ausführen des Befehls verwendet werden soll. Wenn dieses Flag nicht angegeben ist, aber existiert, wird das Profil DEFAULT verwendet.

--progress-format Format

    Das Format zum Anzeigen von Statusprotokollen: default, , append, inplaceoder json

-t, --target Schnur

    Falls zutreffend, das zu verwendende Bündelziel

Erstellen eines Konfigurationsprofils

Führen Sie den configure Befehl aus, um ein Konfigurationsprofil zu erstellen:

databricks configure --host <workspace-url>

Die Eingabeaufforderung fordert Sie auf, Ihr persönliches Azure Databricks-Zugriffstoken oder Microsoft Entra ID -Token (ehemals Azure Active Directory) einzugeben, das dem angegebenen <workspace-url>zugeordnet ist:

✔ Databricks Token:

Nachdem Sie Ihr Zugriffstoken eingegeben haben, wird es standardmäßig in der Datei ~/.databrickscfg unter Linux oder macOS bzw. %USERPROFILE%\.databrickscfg unter Windows gespeichert. Die Datei enthält einen standardmäßigen Verbindungsprofileintrag namens DEFAULT:

[DEFAULT]
host  = <workspace-url>
token = <access-token>

Um anstelle von DEFAULT einen anderen Namen für Ihr Verbindungsprofil zu verwenden, fügen Sie dem Befehl --profile die Option configure hinzu, z. B.:

databricks configure --host <workspace-url> --profile <profile-name>

Tip

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.

Alle vorhandenen Host- und Tokeninformationen innerhalb des angegebenen Verbindungsprofils werden mit den neuen Host- und Tokeninformationen überschrieben.