Teilen über

auth Befehlsgruppe

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.

Die auth Befehlsgruppe in der Databricks CLI enthält Authentifizierungsbezogene Befehle, einschließlich der folgenden:

  • Listet alle verfügbaren Authentifizierungskonfigurationsprofile auf.
  • Abrufen von Informationen zu einem individuellen Authentifizierungskonfigurationsprofil.
  • Verwenden Sie die OAuth-User-to-Machine-Authentifizierung (U2M), um die Databricks CLI mit Ihren Azure Databricks-Konten und -Arbeitsbereichen zu authentifizieren.
  • Rufen Sie Informationen zu allen OAuth-Zugriffstoken ab, welche die Databricks CLI möglicherweise zwischengespeichert hat.
  • Rufen Sie Details zur Konfiguration ab, die die Databricks CLI zur Authentifizierung verwendet.

Tip

Führen Sie zum Abrufen von Informationen über den aktuellen Databricks CLI-Benutzer aus databricks current-user me.

Databricks-Authentifizierung beschreiben

Beschreibt die Konfiguration, die die Databricks CLI zur Authentifizierung verwendet, einschließlich der Anmeldeinformationen und der Quelle dieser Anmeldeinformationen. Wenn keine Optionen angegeben sind, folgt der auth describe Befehl der Priorität der Authentifizierungsmethode.

databricks auth describe [flags]

Optionen

--sensitive

    Einschließen vertraulicher Felder wie Kennwörter und Token in die Ausgabe

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel wird die aktuelle Authentifizierungskonfiguration beschrieben:

databricks auth describe

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: default
  ✓ auth_type: <authentication-type> (from <path>/<to>/.databrickscfg config file)

Um anzugeben, dass Informationen zu einem bestimmten Azure Databricks-Arbeitsbereich verwendet werden, geben Sie die --host Option zusammen mit der URL des Arbeitsbereichs an.

databricks auth describe --host https://<workspace-instance-name>

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from --host flag)
  ✓ profile: default
  ✓ auth_type: <authentication-type>

Um anzugeben, dass Informationen zu einem bestimmten Azure Databricks-Konto verwendet werden, geben Sie die --host Option zusammen mit der Azure Databricks-Kontokonsolen-URL https://accounts.azuredatabricks.net an.

databricks auth describe --host <account-console-url>

Host: <account-console-url>
User: <user-name>@<domain>
AccountId: <account-id>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: <account-console-url> (from --host flag)
  ✓ account_id: <account-id>
  ✓ profile: default
  ✓ auth_type: <authentication-type>

Um anzugeben, dass Informationen zu einem bestimmten Azure Databricks-Konfigurationsprofil verwendet werden, geben Sie die -p Option zusammen --profile mit dem Namen des Profils an:

databricks auth describe -p TEST

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: ******** (from <path>/<to>/.databrickscfg config file)
  ✓ profile: TEST (from --profile flag)
  ✓ auth_type: <authentication-type>

Um vertrauliche Informationen in die Ausgabe einzuschließen (z. B. Azure Databricks persönliche Zugriffstoken und geheime Clientschlüssel), geben Sie die --sensitive Option an:

databricks auth describe --sensitive

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: pat
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: <token-value> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: <profile-name>
  ✓ auth_type: pat

Databricks-Authentifizierungsumgebung

Rufen Sie Informationen zu einem vorhandenen Konfigurationsprofil mithilfe des Namens des Profils oder der Azure Databricks-Kontokonsolen-URL oder der Azure Databricks-Arbeitsbereichs-URL ab.

databricks auth env [flags]

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.

Informationen zum Erstellen eines Konfigurationsprofils finden Sie im configure Befehl.

Optionen

--host string

    Hostname zum Abrufen der Authentifizierungs-Env für

Note

Wenn mehr als ein Profil mit dem Wert --host übereinstimmt, wird ein Fehler angezeigt, der besagt, dass es kein einzelnes übereinstimmende Profil finden kann. Beispielsweise können Sie über ein Profil verfügen, das nur über einen Hostwert und ein anderes Profil verfügt, das denselben Hostwert, aber auch einen Tokenwert aufweist. In diesem Fall wählt die Databricks CLI kein Profil aus und wird beendet. Um die Databricks CLI bei der Auswahl des gewünschten Profils zu unterstützen, versuchen Sie, einen anderen --host-Wert anzugeben. Versuchen Sie bei --host-Werten, die Kontokonsolen-URLs sind, einen --account-id-Wert anstelle eines --host-Werts anzugeben.

--profile string

    Profil zum Abrufen der Authentifizierungs-Env für

Globale Kennzeichnungen

Beispiele

Das folgende Beispiel ruft die Standardauthentifizierungsumgebung ab:

databricks auth env

Das folgende Beispiel ruft die Authentifizierungsumgebung für einen bestimmten Host ab:

databricks auth env --host https://my-workspace.cloud.databricks.com

Die Ausgabe für ein Profil, das mit azure Databricks-Zugriffstokenauthentifizierung konfiguriert ist, kann folgendes sein:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "TEST",
    "DATABRICKS_HOST": "https://my-workspace.cloud.databricks.com",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

Das folgende Beispiel ruft die Authentifizierungsumgebung für ein bestimmtes Profil ab:

databricks auth env --profile my-test-environment

databricks-Authentifizierungsanmeldung

Melden Sie sich bei einem Databricks-Arbeitsbereich oder -Konto an, und speichern Sie die Authentifizierungskonfiguration in einem Profil ( ~/.databrickscfg standardmäßig). Das Profil kann dann verwendet werden, um andere Databricks CLI-Befehle mithilfe des --profile Flags zu authentifizieren. Das Profil kann auch verwendet werden, um andere Databricks-Tools zu authentifizieren, die die einheitliche Databricks-Authentifizierung unterstützen, einschließlich der Databricks Python, Java und Go SDKs.

databricks auth login HOST [flags]

Für diesen Befehl ist eine Databricks-Host-URL (mit --host oder als Positionsargument oder implizit aus dem angegebenen Profilnamen abgeleitet) und ein Profilname (mit --profile) erforderlich, der angegeben werden soll. Wenn Sie diese Werte nicht angeben, werden Sie zur Laufzeit zur Eingabe von Werten aufgefordert.

Während dieser Befehl Sie immer beim angegebenen Host anmeldet, hängt das Verhalten von den vorhandenen Profilen ab, die Sie in Ihrer Konfigurationsdatei festgelegt haben (standardmäßig ~/.databrickscfg ):

  1. Wenn ein Profil mit dem angegebenen Namen vorhanden ist und einen Host angibt, werden Sie beim vom Profil angegebenen Host angemeldet. Das Profil wird aktualisiert, um "databricks-cli" als Authentifizierungstyp zu verwenden, wenn dies noch nicht der Fall war.
  2. Wenn ein Profil mit dem angegebenen Namen vorhanden ist, aber keinen Host angibt, werden Sie aufgefordert, einen Host anzugeben. Das Profil wird aktualisiert, um den angegebenen Host zu verwenden. Der Authentifizierungstyp wird auf "databricks-cli" aktualisiert, wenn dies nicht der Fall war.
  3. Wenn ein Profil mit dem angegebenen Namen vorhanden ist und einen Host angibt, Sie aber einen Host mit --host (oder als HOST Positionsargument) angeben, wird das Profil aktualisiert, um den neu angegebenen Host zu verwenden. Der Authentifizierungstyp wird auf "databricks-cli" aktualisiert, wenn dies nicht der Fall war.
  4. Wenn kein Profil mit dem angegebenen Namen vorhanden ist, wird mit dem angegebenen Host ein neues Profil erstellt. Der Authentifizierungstyp wird auf "databricks-cli" festgelegt.

Argumente

HOST

    Databricks-Host-URL (optional)

Optionen

--configure-cluster

    Aufforderungen zum Konfigurieren des Clusters (klassische Berechnung)

--configure-serverless

    Aufforderungen zum Konfigurieren der serverlosen Berechnung

--timeout duration

    Timeout zum Abschließen einer Anmeldeabfrage im Browser (Standard 1h0m0s)

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel wird ein Databricks-Arbeitsbereich protokolliert:

databricks auth login

Im folgenden Beispiel wird ein bestimmter Databricks-Arbeitsbereich protokolliert:

databricks auth login https://my-workspace.cloud.databricks.com

Das folgende Beispiel meldet sich mit einem bestimmten Profil an und konfiguriert Clustereinstellungen:

databricks auth login --profile my-profile --configure-cluster

Im folgenden Beispiel wird ein benutzerdefiniertes Timeout für den Anmeldevorgang festgelegt:

databricks auth login --timeout 30m

Databricks-Authentifizierungsprofile

Listet alle verfügbaren Konfigurationsprofile (standardmäßig ~/.databrickscfg ) auf, und überprüfen Sie, ob sie gültige Profile sind.

databricks auth profiles [flags]

Mit diesem Befehl werden Profile im folgenden Format ausgegeben:

Name            Host                Valid
DEFAULT         https://<host-url>  YES
<profile-name>  https://<host-url>  NO

Um festzustellen, ob jedes Profil gültig ist, listet die Databricks CLI Arbeitsbereiche für jedes Profil auf Kontoebene auf und führt einen aktuellen Benutzerbefehl für jedes Profil auf Arbeitsbereichsebene aus. Wenn der Befehl erfolgreich ist, wird ein YES angezeigt; andernfalls wird ein NO angezeigt.

Die Ausgabe des auth profiles-Befehls zeigt keine Zugriffstoken an. Informationen zum Anzeigen eines Zugriffstokens finden Sie unter databricks auth env.

Standardmäßig werden Konfigurationsprofile in der Datei ~/.databrickscfg unter Linux oder macOS oder %USERPROFILE%\.databrickscfg unter Windows gespeichert. Sie können den Standardpfad dieser Datei ändern, indem Sie die Umgebungsvariable DATABRICKS_CONFIG_FILE festlegen.

Informationen zum Erstellen von Konfigurationsprofilen finden Sie im configure Befehl.

Optionen

--skip-validate

    Gibt an, ob die Überprüfung der Profile übersprungen werden soll

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel werden alle Authentifizierungsprofile aufgelistet:

databricks auth profiles

Im folgenden Beispiel werden Profile aufgelistet, ohne sie zu überprüfen:

databricks auth profiles --skip-validate

databricks-Authentifizierungstoken

Abrufen des Authentifizierungstokens aus dem lokalen Cache in ~/.databricks/token-cache.json. Aktualisieren Sie das Zugriffstoken, wenn es abgelaufen ist. Dieser Befehl funktioniert nur mit der U2M-Authentifizierung (mit dem databricks auth login Befehl). Die M2M-Authentifizierung mit einer Client-ID und einem geheimen Schlüssel wird nicht unterstützt.

databricks auth token [HOST] [flags]

Informationen zum Konfigurieren und Einrichten der OAuth U2M-Authentifizierung finden Sie unter OAuth-User-to-Machine-Authentifizierung (U2M).

Argumente

HOST

    Databricks-Host-URL (optional)

Optionen

--account-id string

    Databricks-Konto-ID

--timeout duration

    Timeout zum Abrufen eines Tokens. (Standard 1h0m0s)

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel wird das Authentifizierungstoken abgerufen:

databricks auth token

Im folgenden Beispiel wird das Authentifizierungstoken für einen bestimmten Host abgerufen:

databricks auth token https://my-workspace.cloud.databricks.com

Die Ausgabe kann folgendes sein:

{
  "access_token": "<token-value>",
  "token_type": "Bearer",
  "expiry": "<token-expiration-date-time>"
}

Im folgenden Beispiel wird ein benutzerdefiniertes Timeout für die Tokenerfassung festgelegt:

databricks auth token --timeout 30m

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 und das Profil existiert, wird das benannte DEFAULT Profil verwendet.

--progress-format Format

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

-t, --target Schnur

    Falls zutreffend, das zu verwendende Bündelziel

  • Last updated on