Teilen über


Azure Databricks-Konfigurationsprofile

Ein Azure Databricks-Konfigurationsprofil speichert Authentifizierungseinstellungen in der .databrickscfg Datei. Konfigurationsprofile vereinfachen den Wechsel zwischen verschiedenen Arbeitsbereichen, Umgebungen oder Authentifizierungsmethoden, ohne den Code zu ändern.

Tools, SDKs, Skripts und Apps können auf Konfigurationsprofile verweisen, um sich mit Azure Databricks zu authentifizieren. Alle Tools und SDKs, die einheitliche Authentifizierungsunterstützungskonfigurationsprofile implementieren.

Was ist ein Konfigurationsprofil?

Ein Konfigurationsprofil ist ein benannter Abschnitt in der .databrickscfg-Datei, der Folgendes enthält:

  • Authentifizierungsdaten, wie Token oder Dienstprinzipal-Zugangsdaten
  • Die Azure Databricks-Arbeitsbereich- oder Konto-URL
  • Optionale Einstellungen, die für Ihre Authentifizierungsmethode spezifisch sind

Erstellen Sie mehrere Profile in einer einzelnen .databrickscfg Datei, um Verbindungen mit verschiedenen Arbeitsbereichen oder Umgebungen wie Entwicklung, Staging und Produktion zu verwalten.

Erstellen eines Konfigurationsprofils

Erstellen Sie ein Konfigurationsprofil mithilfe der Databricks CLI oder durch manuelles Bearbeiten der .databrickscfg Datei.

Erstellen eines Profils mit der CLI

Die einfachste Möglichkeit zum Erstellen eines Konfigurationsprofils für die interaktive Benutzerauthentifizierung ist die Databricks CLI:

databricks auth login --host <workspace-url>

Die CLI öffnet Ihren Webbrowser, um den Authentifizierungsfluss abzuschließen. Nach der Anmeldung speichert die CLI die Anmeldeinformationen als Konfigurationsprofil.

Manuelles Erstellen eines Profils

So erstellen Sie ein Konfigurationsprofil manuell:

  1. Erstellen Sie eine Datei mit dem Namen .databrickscfg in Ihrem Startverzeichnis:

    • Unix, Linux, macOS:~/.databrickscfg
    • Windows: %USERPROFILE%\.databrickscfg
  2. Fügen Sie ein Profil mit dem folgenden Format hinzu:

    [<profile-name>]
    <field-name> = <field-value>
    

    Ersetzen Sie die Platzhalter:

    • <profile-name>: Ein eindeutiger Name wie DEFAULT, , DEVELOPMENToder PRODUCTION
    • <field-name> und <field-value>: Die Authentifizierungsfelder für Ihre Authentifizierungsmethode

Die Datei sieht z. B. für OAuth Machine-to-Machine (M2M) Authentifizierung wie folgt aus:

[DEFAULT]
host          = https://<workspace-url>
client_id     = <client-id>
client_secret = <client-secret>

Erstellen mehrerer Profile

Definieren Sie mehrere Profile in derselben .databrickscfg Datei, um verschiedene Arbeitsbereiche oder Umgebungen zu verwalten. Jedes Profil muss einen eindeutigen Namen haben.

[DEFAULT]
host          = https://production-workspace-url
client_id     = <production-client-id>
client_secret = <production-client-secret>

[DEVELOPMENT]
host          = https://dev-workspace-url
client_id     = <dev-client-id>
client_secret = <dev-client-secret>

[STAGING]
host          = https://staging-workspace-url
client_id     = <staging-client-id>
client_secret = <staging-client-secret>

Kombinieren von Authentifizierungstypen

Definieren Sie mehrere Authentifizierungsmethoden in separaten Profilen in Ihrer Konfigurationsdatei. Dies ist nützlich, wenn Sie unterschiedliche Anmeldeinformationen für verschiedene Workflows oder Tools verwenden möchten. Sie können beispielsweise die cloudeigene Authentifizierung für die interaktive Verwendung und OAuth-Anmeldeinformationen für die Automatisierung verwenden:

[DEFAULT]
host = https://<workspace-url>

[SERVICE_PRINCIPAL]
azure_workspace_resource_id = /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.Databricks/workspaces/<workspace-name>
azure_tenant_id             = <tenant-id>
azure_client_id             = <client-id>
azure_client_secret         = <client-secret>

Weitere Informationen zu Authentifizierungstypen und den erforderlichen Feldern finden Sie unter "Databricks unified authentication".

Verwenden eines Konfigurationsprofils

Nachdem Sie ein Konfigurationsprofil erstellt haben, verweisen Sie in Ihren Tools und Code darauf. Wenn Sie keinen Profilnamen angeben, verwenden Azure Databricks-Tools und SDKs automatisch das DEFAULT Profil.

Um ein anderes Profil als DEFAULTzu verwenden, geben Sie den Profilnamen an:

Mit der Databricks CLI:

databricks workspace list --profile DEVELOPMENT

Mit Umgebungsvariable:

export DATABRICKS_CONFIG_PROFILE=DEVELOPMENT
databricks workspace list

Mit dem Python SDK:

from databricks.sdk import WorkspaceClient

# Specify profile in code
w = WorkspaceClient(profile="DEVELOPMENT")

# Or use environment variable DATABRICKS_CONFIG_PROFILE

Bewährte Methoden

  • Verwenden Sie das STANDARDprofil für Ihren am häufigsten verwendeten Arbeitsbereich, um die Notwendigkeit zu minimieren, Profilnamen anzugeben.
  • Verwenden Sie beschreibende Profilnamen wie PRODUCTION, DEVELOPMENToder STAGING anstelle von generischen Namen.
  • Schützen Sie Ihre .databrickscfg Datei, indem Sie eingeschränkte Dateiberechtigungen festlegen (nur von Ihrem Benutzer lesbar).
  • Commiten Sie nicht .databrickscfg in die Versionskontrolle. Fügen Sie sie Zu Ihrer .gitignore Datei hinzu.
  • Verwenden Sie Dienstprinzipale für Produktionsworkloads anstelle von persönlichen Zugriffstoken.
  • Wechseln Sie die Anmeldeinformationen regelmäßig und aktualisieren Sie Ihre Profile entsprechend.

Problembehandlung

Wenn das Profil nicht gefunden werden kann, überprüfen Sie Folgendes:

  • Die .databrickscfg Datei befindet sich in Ihrem Startverzeichnis.
  • Sie verwenden den genauen Profilnamen.
  • Die Datei heißt nicht .databrickscfg.txt oder etwas Ähnliches.

Wenn die Authentifizierung fehlschlägt, überprüfen Sie Folgendes:

  • Ihre Anmeldeinformationen sind aktuell und sind nicht abgelaufen.
  • Die host URL ist richtig.
  • Sie verfügen über die erforderlichen Berechtigungen für die Vorgänge, die Sie versuchen.

Testen Sie Ihre Konfigurationsprofile mithilfe der Databricks CLI:

# Inspect a specific profile
databricks auth env --profile DEVELOPMENT

# List all profiles
databricks auth profiles

Weitere Informationen finden Sie unter Testen der Konfigurationsprofile.

Learn more