Profils de configuration pour l’interface CLI Databricks

Remarque

Ces informations s’appliquent à Databricks CLI versions 0.205 et ultérieures. L’interface CLI Databricks est en préversion publique.

L’utilisation de l’interface CLI Databricks est soumise à la licence Databricks et à la notification de confidentialité Databricks, y compris les dispositions relatives aux données d’utilisation.

Cet article explique comment utiliser l’interface CLI Databricks avec des profils de configuration. Il part du principe que vous avez déjà installé l’interface CLI Databricks et créé un fichier de profils de configuration Databricks. Consultez Installer ou mettre à jour l’interface CLI Databricks et Profils de configuration Azure Databricks.

Obtenir 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 différents espaces de travail en spécifiant le nom du profil de configuration cible dans l’indicateur --profile ou -p de la commande. S’il n’est pas spécifié, le profil de configuration DEFAULT est utilisé.

Conseil

Vous pouvez appuyer sur Tab après --profile ou -p pour afficher la liste des profils de configuration disponibles existants à partir desquels choisir.

Par exemple, vous pouvez avoir un profil de configuration nommé DEV qui fait référence à un espace de travail Azure 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 espace de travail Azure Databricks que vous utilisez pour les charges de travail de production.

Par défaut, l’interface CLI Databricks recherche le fichier .databrickscfg dans votre dossier ~ (dossier de base d’utilisateur) sur Unix, Linux ou macOS, ou dans votre dossier %USERPROFILE% (dossier de base d’utilisateur) sur Windows. Pour modifier le chemin d’accès par défaut du fichier .databrickscfg, définissez la variable d’environnement DATABRICKS_CONFIG_FILE sur un chemin différent. Consultez Variables et champs d’environnement spécifiques à .databrickscfg.

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

databricks auth env --profile <configuration-profile-name>

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

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

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

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "DEFAULT",
    "DATABRICKS_HOST": "https://dbc-a1b2345c-d6e7.cloud.databricks.com",
    "DATABRICKS_TOKEN": "dapi123..."
  }
}

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

databricks auth profiles

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 un jeton d’accès, exécutez la commande auth env précédente.

Important

L’interface CLI Databricks ne fonctionne pas avec un fichier .netrc. Vous pouvez avoir un fichier .netrc dans votre environnement à d’autres fins, mais l’interface CLI Databricks n’utilise pas ce fichier .netrc.

Tester 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 espace de travail.

Si vous ne spécifiez pas de profil, le profil par défaut est utilisé. Par exemple, la commande suivante répertorie les versions de Databricks Runtime disponibles pour l’espace de travail Azure Databricks associé à votre profil de DEFAULT.

Remarque

Cette commande suppose que vous n’avez pas de variables d’environnement définies qui sont prioritaires sur les paramètres de votre profil DEFAULT. Pour plus d’informations, consultez la section Ordre d’évaluation de l’authentification.

databricks clusters spark-versions

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

databricks clusters spark-versions -p PROD