Freigeben über

auth-Befehlsgruppe

  • 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.

Die auth-Befehlsgruppe in der Databricks CLI ermöglicht Ihnen Folgendes:

  • 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.

Sie führen auth-Befehle aus, indem Sie sie an databricks auth anfügen. Führen Sie databricks auth -h aus, um Hilfe zum auth-Befehl anzuzeigen.

Auflisten von Konfigurationsprofilen

Um eine Liste aller verfügbaren Konfigurationsprofile abzurufen und zu überprüfen, ob sie gültig sind, führen Sie den Befehl auth profiles wie folgt aus:

databricks auth profiles

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

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

Um festzustellen, ob jedes Profil gültig ist, führt die Databricks CLI einen Listenarbeitsbereichsbefehl für jedes Profil auf Kontoebene und 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 Abrufen von Informationen zu einem Konfigurationsprofil.

Konfigurationsprofile werden standardmäßig in der Datei ~/.databrickscfg unter Linux oder macOS bzw. %USERPROFILE%\.databrickscfg unter Windows gespeichert. Sie können den Standardpfad dieser Datei ändern, indem Sie die Umgebungsvariable DATABRICKS_CONFIG_FILE festlegen. Informationen zum Festlegen von Umgebungsvariablen finden Sie in der Dokumentation Ihres Betriebssystems.

Informationen zum Erstellen von Konfigurationsprofilen finden Sie unter Befehlsgruppe konfigurieren.

Abrufen von Informationen zu Konfigurationsprofilen

Um Informationen zu einem vorhandenen Konfigurationsprofil abzurufen, führen Sie den Befehl auth env aus, wobei <profile-name> der Name des Profils und <account-or-workspace-url> die Azure Databricks-Kontokonsolen-URL oder die Azure Databricks-Arbeitsbereichs-URL wie folgt darstellt:

databricks auth env --profile <profile-name>

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

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.

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

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

Hinweis

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.

Informationen zum Erstellen von Konfigurationsprofilen finden Sie unter Befehlsgruppe konfigurieren.

Authentifizieren mit OAuth

Anstatt sich mit Azure Databricks mithilfe von Zugriffstoken und Konfigurationsprofilen zu authentifizieren, können Sie die OAuth-User-to-Machine-Authentifizierung (U2M) verwenden. OAuth bietet Token mit schnelleren Ablaufzeiten als persönliche Azure Databricks-Zugriffstoken und bietet eine bessere serverseitige Sitzungsinvalidierung und Bereichsdefinition. Da OAuth-Zugriffstoken in weniger als einer Stunde ablaufen, verringert dies das Risiko, dass versehentlich Token in die Quellcodeverwaltung eingecheckt werden. Siehe Authentifizierung des Zugriffs auf Azure Databricks mit einem Benutzerkonto mithilfe von OAuth (OAuth U2M).

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

Abrufen von OAuth-Zugriffstokendetails

Wenn Sie Informationen zum zwischengespeicherten OAuth-Zugriffstoken anzeigen möchten, das die Databricks CLI zuvor für einen Azure Databricks-Arbeitsbereich generiert hat, führen Sie den auth token-Befehl aus, wobei <workspace-url> die URL des Azure Databricks-Arbeitsbereichs wie folgt darstellt:

databricks auth token <workspace-url>

Ausgabe:

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

Authentifizierungsdetails abrufen

Um Details zur Konfiguration abzurufen, die die Databricks CLI zur Authentifizierung verwendet, führen Sie den auth describe Befehl aus.

Wenn keine Optionen angegeben werden, folgt der Befehl auth describe den Standardmethoden für die einheitliche Client-Authentifizierung.

databricks auth describe

Ausgabe:

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>

Ausgabe:

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>

Ausgabe:

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 oder --profile Option zusammen mit dem Namen des Profils an.

databricks auth describe -p <profile-name>

Ausgabe:

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: <profile-name> (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

Ausgabe:

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