Didacticiel 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.
L’interface de ligne de commande Databricks (également appelée interface CLI Databricks) est un utilitaire dont l’interface simple d’utilisation vous permet d’automatiser la plateforme Azure Databricks à partir de votre terminal, de l’invite de commandes ou de scripts d’automatisation.
Cet article explique comment utiliser votre ordinateur de développement local pour commencer rapidement avec l’interface CLI Databricks. Consultez Qu’est-ce que l’interface CLI Databricks ?.
Le tutoriel pratique suivant suppose :
Pour Linux ou macOS, homebrew est installé.
Remarque
Si vous ne pouvez pas utiliser Homebrew, pour d’autres façons d’installer l’interface CLI, consultez Installer ou mettre à jour l’interface CLI Databricks.
Pour Windows, vous avez installé winget, Chocolatey ou le Sous-système Windows pour Linux (WSL). Pour obtenir des instructions d’installation, consultez la documentation de votre système d’exploitation.
Remarque
L’installation de l’interface CLI Databricks avec Chocolatey est Expérimentale.
Si vous ne pouvez pas utiliser
winget
, Chocolatey ou WSL, d’autres méthodes d’installation de la CLI sont disponibles, veuillez consulter la rubrique Installer ou mettre à jour l’interface CLI Databricks.
Suivez les étapes ci-dessous :
Si elle n’est pas déjà installée, installez l’interface CLI Databricks de la manière suivante :
Linux, macOS
Utilisez Homebrew pour installer l’interface CLI Databricks en exécutant les deux commandes suivantes :
brew tap databricks/tap brew install databricks
Windows
Vous pouvez utiliser winget, Chocolatey ou WSL (Sous-système Windows pour Linux) pour installer l’interface CLI Databricks. Si vous ne pouvez pas utiliser
winget
Chocolatey ou WSL, vous devez ignorer cette procédure et utiliser l’invite de commande ou PowerShell pour installer l’interface CLI Databricks depuis la source à la place.Remarque
L’installation de l’interface CLI Databricks avec Chocolatey est Expérimentale.
Pour installer l’interface CLI Databricks via
winget
, exécutez les deux commandes suivantes, puis redémarrez votre invite de commandes :winget search databricks winget install Databricks.DatabricksCLI
Pour utiliser Chocolatey pour installer l’interface CLI Databricks, exécutez la commande suivante :
choco install databricks-cli
Pour utiliser WSL pour installer l’interface CLI Databricks :
Installez
curl
etzip
via WSL. Pour plus d'informations, consultez la documentation de votre système d'exploitation.Utilisez WSL pour installer l’interface CLI Databricks en exécutant la commande suivante :
curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/main/install.sh | sh
Vérifiez que l’interface CLI Databricks est installée en exécutant la commande suivante, qui affiche la version actuelle de l’interface CLI Databricks installée. Cette version doit être la version 0.205.0 ou ultérieure :
databricks -v
Remarque
Si vous exécutez
databricks
mais que vous obtenez une erreur telle quecommand not found: databricks
, ou si vous exécutezdatabricks -v
et qu’un numéro de version 0.18 ou inférieur est affiché, votre ordinateur ne trouve pas la version correcte de l’exécutable de l’interface CLI Databricks. Pour résoudre ce problème, consultez Vérifier l’installation de votre interface CLI.
Après avoir installé l’interface CLI Databricks, suivez les étapes suivantes :
Remarque
Ce tutoriel suppose que vous souhaitez utiliser l’authentification utilisateur à machine (U2M) OAuth pour authentifier l’interface CLI à l’aide de votre compte d’utilisateur Azure Databricks. Pour configurer l’interface CLI afin d’utiliser d’autres types d’authentification Databricks, consultez Authentification pour l’interface CLI Databricks.
Utilisez l’interface CLI Databricks pour lancer localement la gestion des jetons OAuth en exécutant la commande suivante pour chaque compte ou espace de travail cible.
Pour les opérations au niveau du compte, remplacez les espaces réservés suivants dans la commande suivante :
- Remplacez
<account-console-url>
par votre https://accounts.azuredatabricks.net API Azure Databricks. - Remplacez
<account-id>
par l’ID de votre compte Azure Databricks. Consultez Localiser votre ID de compte.
databricks auth login --host <account-console-url> --account-id <account-id>
Pour les opérations au niveau de l’espace de travail, dans la commande suivante, remplacez
<workspace-url>
par votre URL d’espace de travail Azure Databricks, par exemplehttps://adb-1234567890123456.7.azuredatabricks.net
.databricks auth login --host <workspace-url>
- Remplacez
L’interface CLI Databricks vous invite à enregistrer les informations que vous avez entrées en tant que profil de configuration Azure Databricks. Appuyez sur
Enter
pour accepter le nom de profil suggéré, ou entrez le nom d’un profil nouveau ou existant. Tout profil existant portant le même nom est remplacé par les informations que vous avez entrées. Vous pouvez utiliser des profils pour changer rapidement votre contexte d’authentification entre plusieurs comptes ou espaces de travail.Pour obtenir la liste des profils existants, dans un autre terminal ou une autre invite de commandes, utilisez l’interface CLI Databricks pour exécuter la commande
databricks auth profiles
. Pour voir les paramètres existants d’un profil spécifique, exécutez la commandedatabricks auth env --profile <profile-name>
.Dans votre navigateur web, suivez les instructions à l’écran pour vous connecter à votre compte ou à votre espace de travail Azure Databricks.
Pour voir la valeur du jeton OAuth actuel d’un profil et l’horodatage de l’expiration à venir du jeton, exécutez l’une des commandes suivantes :
Pour les opérations au niveau du compte, exécutez les commandes suivantes :
databricks auth token -p <profile-name>
databricks auth token --host <workspace-url> --account-id <account-id>
databricks auth token --host <workspace-url> --account-id <account-id> -p <profile-name>
Si vous avez plusieurs profils avec les mêmes valeurs
--host
et--account-id
, il peut être nécessaire de spécifier les options--host
,--account-id
et-p
ensemble pour permettre à l’interface CLI Databricks de trouver les informations du jeton OAuth correspondant.Pour les opérations au niveau de l’espace de travail, exécutez les commandes suivantes :
databricks auth token -p <profile-name>
databricks auth token --host <workspace-url>
databricks auth token --host <workspace-url> -p <profile-name>
Si vous avez plusieurs profils avec les mêmes valeurs
--host
, il peut être nécessaire de spécifier les options--host
et-p
ensemble pour permettre à l’interface CLI Databricks de trouver les informations du jeton OAuth correspondant.
Étapes suivantes
Après avoir configuré l’interface CLI Databricks :
- Pour savoir comment utiliser l’interface CLI, consultez l’utilisation de base pour l’interface CLI Databricks.
- Pour obtenir une vue d’ensemble des commandes CLI disponibles, consultez Commandes CLI Databricks.
- Si l’interface CLI ne s’exécute pas ou produit des résultats inattendus, consultez Vérifier l’installation de votre interface CLI.