configure commande
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.
La commande configure au sein du CLI Databricks vous permet d'authentifier le CLI Databricks auprès de Databricks à l'aide des jetons d'accès personnels Databricks.
En tant que bonne pratique de sécurité lorsque vous vous authentifiez avec des outils, des systèmes, des scripts et des applications automatisés, Databricks vous recommande d'utiliser des jetons OAuth.
Si vous utilisez l'authentification par jeton d'accès personnel, Databricks recommande d'utiliser des jetons d'accès personnels appartenant aux Service Principal plutôt qu'aux utilisateurs du Workspace. Pour créer des jetons pour les Service Principals, consultez Gérer les jetons pour un Service Principal.
Cet article ne couvre que l'authentification par jeton Databricks pour permettre l'appel de commandes au niveau du Workspace. Pour des options de configuration d'authentification supplémentaires, voir Authentification pour la CLI Databricks.
configuration Databricks
Configurer un profil dans votre fichier ~/.databrickscfg. Un profil de configuration est un ensemble de paramètres qui contient des informations d’authentification telles qu’une URL de workspace Databricks et une valeur de jeton d’accès.
Un profil de configuration possède un nom programmatique, tel que DEFAULT, DEV ou PROD. L'ajout de plusieurs profils au fichier .databrickscfg vous permet d'exécuter rapidement des commandes sur différents Workspace en spécifiant le nom du profil de connexion cible dans l'option --profile de la commande. Si vous ne spécifiez pas l'option --profile dans une commande qui prend en charge cette option, la commande utilisera le profil de connexion DEFAULT par default.
Par exemple, vous pourriez avoir un profil de connexion 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 connexion distinct nommé PROD qui fait référence à un autre Workspace Databricks que vous utilisez pour les charges de travail de production.
Pour obtenir des informations sur les profils de configuration existants, utilisez le groupe de commandesauth.
Vous pouvez modifier le chemin par default du fichier .databrickscfg en définissant la variable d’environnement DATABRICKS_CONFIG_FILE.
Si cette commande est invoquée en mode non interactif, elle lira le jeton depuis stdin. L'hôte doit être spécifié avec l'indicateur --host ou la variable d'environnement DATABRICKS_HOST.
databricks configure [flags]
Options
--configure-cluster
Invite à configurer les clusters
--host string
URL d'hôte du Workspace Databricks
L'URL d'hôte du Workspace est https:// suivi du nom de votre instance, par exemple https://<prefix>.cloud.databricks.com. Pour obtenir le nom de votre instance, veuillez consulter Noms d'instance Workspace, URL et ID.
--profile string
Nom du profil de connexion à configurer. (default "DEFAULT")
Exemples
L'exemple suivant configure l'authentification pour le profil default :
databricks configure
L'exemple suivant configure l'authentification pour un profil spécifique :
databricks configure --profile my-profile
L'exemple suivant configure l'authentification avec un hôte spécifique :
databricks configure --host https://my-workspace.cloud.databricks.com
L'exemple suivant configure l'authentification avec la configuration du cluster :
databricks configure --configure-cluster
Drapeaux globaux
--debug
Activer ou non la journalisation de débogage.
-h OU --help
Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.
--log-file chaîne
Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.
--log-format Format
Le type de format de log, text ou json. La valeur par default est text.
--log-level chaîne
Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.
-o, --output Type
Le type de sortie de commande, text ou json. La valeur par default est text.
-p, --profile chaîne
Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.
--progress-format Format
Le format pour afficher les logs de progression : default, append, inplace ou json
-t, --target chaîne
Le cas échéant, la cible de bundle à utiliser
Créer un profil de configuration
Pour créer un profil de configuration, exécutez la commande configure :
databricks configure --host <workspace-url>
La commande vous invite à saisir votre jeton d'accès personnel Databricks qui correspond au <workspace-url> spécifié :
✔ Databricks Token:
Une fois votre jeton d'accès saisi, votre jeton d'accès est stocké dans le fichier ~/.databrickscfg sur Linux ou macOS, ou %USERPROFILE%\.databrickscfg sur Windows par default. Le fichier contient une entrée de profil de connexion default nommée DEFAULT:
[DEFAULT]
host = <workspace-url>
token = <access-token>
Pour utiliser un nom différent pour votre profil de connexion au lieu de DEFAULT, ajoutez l’option --profile à la commande configure, par exemple :
databricks configure --host <workspace-url> --profile <profile-name>
Vous pouvez appuyer sur Tab après --profile ou -p pour afficher une liste de profils de configuration disponibles existants parmi lesquels choisir, au lieu de saisir manuellement le nom du profil de configuration.
Toutes les informations d'hôte et de jeton existantes dans le profil de connexion spécifié sont écrasées par les nouvelles informations d'hôte et de jeton.