Aller au contenu principal
Dernière mise à jour le

Profils de configuration pour la CLI Databricks

remarque

L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.

Cet article décrit comment utiliser la CLI Databricks avec des profils de configuration. Cela suppose que vous avez déjà installé la CLI Databricks et créé un fichier de profils de configuration Databricks. Consultez Installer ou mettre à jour la CLI Databricks et Profils de configuration Databricks.

Obtenez des informations sur les profils de configuration​

L'ajout de plusieurs profils de configuration au fichier .databrickscfg vous permet d'exécuter rapidement des commandes sur divers Workspace en spécifiant le nom du profil de configuration cible dans l'indicateur --profile ou -p de la commande. Si vous ne spécifiez pas de profil, l'interface CLI en sélectionne un dans l'ordre suivant :

  1. La variable d’environnement DATABRICKS_CONFIG_PROFILE, si elle est définie.
  2. Le paramètre default_profile dans la section [__settings__] de .databrickscfg, le cas échéant. Vous pouvez le définir avec databricks auth switch. Voir le commutateur d'authentification Databricks.
  3. Le profil DEFAULT.
astuce

Vous pouvez appuyer sur Tab après --profile ou -p pour afficher une liste de profils de configuration existants disponibles parmi lesquels choisir.

Par exemple, vous pourriez avoir un profil de configuration nommé DEV qui fait référence à un Workspace Databricks que vous utilisez pour les charges de travail de développement et un profil de configuration distinct nommé PROD qui fait référence à un autre Workspace Databricks que vous utilisez pour les charges de travail de production.

Par défaut, le CLI Databricks recherche le fichier .databrickscfg dans votre dossier ~ (votre dossier personnel) sous Unix, Linux ou macOS, ou votre dossier %USERPROFILE% (votre dossier personnel) sous Windows. Pour modifier le chemin par default du fichier .databrickscfg, définissez la variable d'environnement DATABRICKS_CONFIG_FILE sur un chemin différent. Consultez les champs spécifiques à .databrickscfg.

Pour obtenir des informations sur un profil de configuration existant, exécutez la commande auth describe :

Bash
databricks auth describe --profile <configuration-profile-name>

Par exemple, voici la sortie pour un profil configuré avec l'authentification par jeton d'accès personnel Databricks :

Output
Host: https://dbc-a1b2345c-d6e7.cloud.databricks.com
User: user@example.com
Authenticated with: pat
-----
Current configuration:
  ✓ host: https://dbc-a1b2345c-d6e7.cloud.databricks.com (from ~/.databrickscfg config file)
  ✓ token: ******** (from ~/.databrickscfg config file)
  ✓ profile: <configuration-profile-name> (from --profile flag)
  ✓ auth_type: pat
remarque

La commande auth env est obsolète. Utilisez databricks auth describe pour inspecter la configuration d'un profil, ou databricks auth token pour récupérer un jeton d'accès OAuth mis en cache.

Pour obtenir des information sur tous les profils disponibles, exécutez la commande auth profiles :

Bash
databricks auth profiles
Output
Name                     Host                                            Valid
DEFAULT                  https://dbc-a1b2345c-d6e7.cloud.databricks.com  YES
Development              https://dbc-a1b2345c-d6e7.cloud.databricks.com  YES
Staging                  https://dbc-a1b2345c-d6e7.cloud.databricks.com  YES
Production               https://dbc-a1b2345c-d6e7.cloud.databricks.com  YES

La sortie de la commande auth profiles n'affiche aucun jeton d'accès. Pour afficher les détails des jetons d'un profil spécifique, exécutez databricks auth describe --profile <profile-name> ou databricks auth token --profile <profile-name>.

important

Le Databricks CLI ne fonctionne pas avec un fichier .netrc. Vous pouvez avoir un fichier .netrc dans votre environnement à d'autres fins, mais le CLI Databricks n'utilisera pas ce fichier .netrc.

Testez vos profils de configuration​

Pour tester vos profils de configuration et vérifier que vous avez correctement configuré l'authentification, exécutez une commande qui se connecte à un workspace.

Si vous ne spécifiez pas de profil, le profil default est utilisé. Par exemple, la commande suivante liste les versions disponibles de Databricks Runtime pour le workspace Databricks associé à votre profil DEFAULT.

remarque

Cette commande suppose que vous n'avez pas de variables d'environnement définies qui ont priorité sur les paramètres de votre profil DEFAULT. Pour plus d’informations, voir ordre d'évaluation de l'authentification.

Bash
databricks clusters spark-versions

Pour vérifier un profil de configuration spécifique, indiquez le nom du profil à l’aide de l’indicateur -p.

Bash
databricks clusters spark-versions -p PROD
Sur cette page