Partager via

Profils de configuration pour l’interface CLI Databricks

  • Article

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 configurer l’authentification entre l’interface CLI Databricks et vos comptes et espaces de travail Azure Databricks. Consultez Présentation de l’interface CLI Databricks.

Cet article suppose que vous avez déjà installé l’interface CLI Databricks et configuré l’interface CLI pour l’authentification. Consultez l'article :

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 dans différents espaces de travail en spécifiant le nom du profil de configuration cible dans l’option --profile ou -p de la commande, pour les commandes qui prennent en charge cette option. Si vous ne spécifiez pas l’option --profile ou -p dans une commande prenant en charge cette option, la commande utilise le profil de configuration DEFAULT par défaut.

Conseil

Vous pouvez appuyer sur Tab après --profile ou -p pour afficher une liste de profils de configuration disponibles existants à choisir, au lieu d’entrer manuellement le nom du profil de configuration.

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. Vous pouvez modifier le chemin par défaut du fichier .databrickscfg en définissant la variable d’environnement DATABRICKS_CONFIG_FILE. Pour savoir comment définir les variables d’environnement, consultez la documentation de votre système d’exploitation.

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": "<configuration-profile-name>",
    "DATABRICKS_HOST": "<workspace-url>",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

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

databricks auth profiles

Sortie (les points de suspension représentent le contenu omis, par souci de concision) :

{
  "profiles": [
    {
      "name": "<configuration-profile-name>",
      "host": "<workspace-url>",
      "cloud": "<cloud-id>",
      "auth_type": "<auth-type>",
      "valid": true
    },
    {
      "...": "..."
    }
  ]
}

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 la configuration de votre profil de configuration DEFAULT

Pour vérifier si vous avez correctement configuré l’authentification, vous pouvez exécuter une commande telle que la suivante, qui répertorie les versions de Databricks Runtime disponibles pour l’espace de travail Azure Databricks associé à votre profil DEFAULT.

L’appel suivant suppose que vous n’avez pas défini de variables d’environnement spéciales, 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

Tester vos profils de configuration

Pour vérifier si vous avez correctement configuré des profils de configuration, vous pouvez exécuter une commande telle celle qui suit avec l’un de vos noms de profil de configuration au niveau de l’espace de travail. Cette commande répertorie les versions de Databricks Runtime disponibles pour l’espace de travail Azure Databricks associé au profil de configuration spécifié, représenté ici par l’espace réservé <configuration-profile-name> :

databricks clusters spark-versions -p <configuration-profile-name>

Conseil

Vous pouvez appuyer sur Tab après --profile ou -p pour afficher une liste de profils de configuration disponibles existants à choisir, au lieu d’entrer manuellement le nom du profil de configuration.

Pour afficher les détails d’un profil spécifique, exécutez la commande suivante :

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

Pour afficher les détails de tous vos profils disponibles, exécutez la commande suivante :

databricks auth profiles