Partager via

Profils de configuration Azure Databricks

Un profil de configuration Azure Databricks stocke les paramètres d’authentification dans le .databrickscfg fichier. Les profils de configuration facilitent le basculement entre différents espaces de travail, environnements ou méthodes d’authentification sans modifier votre code.

Les outils, kits sdk, scripts et applications peuvent référencer des profils de configuration pour s’authentifier auprès d’Azure Databricks. Tous les outils et kits SDK qui implémentent l'authentification unifiée supportent les profils de configuration.

Qu’est-ce qu’un profil de configuration ?

Un profil de configuration est une section nommée dans le .databrickscfg fichier qui contient les éléments suivants :

  • Identifiants d'authentification, tels que les jetons ou les identifiants du principal de service
  • L’URL de l’espace de travail ou du compte Azure Databricks
  • Paramètres facultatifs spécifiques à votre méthode d’authentification

Créez plusieurs profils dans un fichier unique .databrickscfg pour gérer les connexions à différents espaces de travail ou environnements tels que le développement, la préproduction et la production.

Créer un profil de configuration

Créez un profil de configuration à l’aide de l’interface CLI Databricks ou en modifiant manuellement le .databrickscfg fichier.

Créer un profil avec l’interface CLI

Le moyen le plus simple de créer un profil de configuration pour l’authentification utilisateur interactive consiste à utiliser l’interface CLI Databricks :

databricks auth login --host <workspace-url>

L’interface CLI ouvre votre navigateur web pour terminer le flux d’authentification. Une fois connecté, l’interface CLI enregistre les informations d’identification en tant que profil de configuration.

Créer un profil manuellement

Pour créer manuellement un profil de configuration :

  1. Créez un fichier nommé .databrickscfg dans votre répertoire de base :

    • Unix, Linux, macOS :~/.databrickscfg
    • Windows : %USERPROFILE%\.databrickscfg

  2. Ajoutez un profil au format suivant :

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

    Remplacez les espaces réservés :

    • <profile-name>: nom unique tel que DEFAULT, DEVELOPMENTou PRODUCTION
    • <field-name> et <field-value>: Champs d’authentification pour votre méthode d’authentification

Par exemple, pour l’authentification de machine à machine (M2M) OAuth, le .databrickscfg fichier ressemble à ceci :

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

Créer plusieurs profils

Définissez plusieurs profils dans le même .databrickscfg fichier pour gérer différents espaces de travail ou environnements. Chaque profil doit avoir un nom unique.

[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>

Combiner des types d’authentification

Définissez plusieurs méthodes d’authentification dans des profils distincts dans votre fichier de configuration. Cela est utile lorsque vous souhaitez utiliser différentes informations d’identification pour différents flux de travail ou outils. Par exemple, vous pouvez utiliser l’authentification native cloud pour une utilisation interactive et des informations d’identification OAuth pour l’automatisation :

[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>

Pour plus d’informations sur les types d’authentification et leurs champs requis, consultez l’authentification unifiée Databricks.

Utiliser un profil de configuration

Après avoir créé un profil de configuration, référencez-le dans vos outils et votre code. Si vous ne spécifiez pas de nom de profil, les outils et kits sdk Azure Databricks utilisent automatiquement le DEFAULT profil.

Pour utiliser un profil autre que DEFAULT, spécifiez le nom du profil :

Avec l’interface CLI Databricks :

databricks workspace list --profile DEVELOPMENT

Avec la variable d’environnement :

export DATABRICKS_CONFIG_PROFILE=DEVELOPMENT
databricks workspace list

Avec le Kit de développement logiciel (SDK) Python :

from databricks.sdk import WorkspaceClient

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

# Or use environment variable DATABRICKS_CONFIG_PROFILE

Meilleures pratiques

  • Utilisez le profil DEFAULT pour votre espace de travail le plus courant pour réduire la nécessité de spécifier des noms de profil.
  • Utilisez des noms de profil descriptifs tels que PRODUCTION, DEVELOPMENTou STAGING au lieu de noms génériques.
  • Protégez votre .databrickscfg fichier en définissant des autorisations de fichier restreintes (lisibles uniquement par votre utilisateur).
  • Ne vous commitez .databrickscfg pas sur le contrôle de version. Ajoutez-le à votre .gitignore fichier.
  • Utilisez des identités de service pour les charges de travail de production au lieu de jetons d’accès personnels.
  • Renouvelez régulièrement vos informations d'identification et mettez à jour vos profils en conséquence.

Résolution des problèmes

Si le profil est introuvable, vérifiez ce qui suit :

  • Le .databrickscfg fichier se trouve dans votre répertoire de base.
  • Vous utilisez le nom exact du profil.
  • Le fichier n’est pas nommé .databrickscfg.txt ou similaire.

Si l’authentification échoue, vérifiez ce qui suit :

  • Vos informations d’identification sont actuelles et n’ont pas expiré.
  • L’URL host est correcte.
  • Vous disposez des autorisations requises pour les opérations que vous tentez.

Testez vos profils de configuration à l’aide de l’interface CLI Databricks :

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

# List all profiles
databricks auth profiles

Pour plus d’informations, consultez Tester vos profils de configuration.

Learn more

  • Last updated on