Commande configure

Note

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.

La configure commande dans l’interface CLI Databricks vous permet d’authentifier l’interface CLI Databricks avec Azure Databricks à l’aide de jetons d’accès personnels Azure Databricks ou des jetonsMicrosoft Entra ID (anciennement Azure Active Directory).

Note

En guise de bonne pratique de sécurité, quand vous vous authentifiez avec des outils, systèmes, scripts et applications automatisés, Databricks recommande d’utiliser des jetons d’accès personnels appartenant à des principaux de service et non des utilisateurs de l’espace de travail. Pour créer des jetons pour des principaux de service, consultez Gérer les jetons pour un principal de service.

Notez que cet article couvre uniquement le jeton d’accès personnel Azure Databricks et l’authentification par jeton d’ID Microsoft Entra pour activer l’appel de commandes au niveau de l’espace de travail . Pour en savoir plus sur les options de configuration d’authentification supplémentaires, consultez Authentification pour l’interface CLI Databricks.

databricks configure

Configurez un profil dans votre ~/.databrickscfg fichier. Un profil de configuration est une collection de paramètres qui contient des informations d’authentification telles qu’une URL d’espace de travail Azure Databricks et une valeur de jeton d’accès.

Un profil de configuration possède un nom programmatique, comme DEFAULT, DEV ou PROD. L’ajout de plusieurs profils au .databrickscfg fichier vous permet d’exécuter rapidement des commandes dans différents espaces de travail en spécifiant le nom du profil de connexion cible dans l’option de --profile la commande. Si vous ne précisez pas l’option --profile dans une commande prenant en charge cette option, le profil de connexion DEFAULT sera utilisé par défaut.

Par exemple, vous pouvez avoir un profil de connexion nommé DEV qui fait référence à un espace de travail Azure Databricks utilisé pour les charges de travail de développement, et un autre profil de connexion nommé PROD qui pointe vers un espace de travail Azure Databricks différent, destiné aux charges de travail en production.

Pour obtenir des informations sur les profils de configuration existants, utilisez le auth groupe de commandes.

Vous pouvez modifier le chemin d’accès par défaut du .databrickscfg fichier en définissant la variable DATABRICKS_CONFIG_FILEd’environnement.

Si cette commande est appelée en mode non interactif, elle lit le jeton de 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

    Instructions pour configurer le cluster

--host string

    URL de l’hôte de l’espace de travail Databricks

L’URL de l’hôte de l’espace de travail est votre URL par espace de travail, avec le format https://adb-<workspace-id>.<random-number>.azuredatabricks.net. Pour obtenir l’URL par espace de travail, consultez l’URL par espace de travail.

--profile string

    Nom du profil de connexion à configurer. (valeur par défaut « DEFAULT »)

Indicateurs globaux

Examples

L’exemple suivant configure l’authentification pour le profil par défaut :

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

Indicateurs globaux

--debug

  Active la journalisation du débogage.

-h ou --help

    Affiche l’aide pour l’interface CLI de Databricks, le groupe de commandes associé ou la commande concernée.

--log-file chaîne

    Chaîne représentant le fichier dans lequel écrire les journaux de sortie. Si cet indicateur n’est pas défini, les journaux de sortie sont écrits par défaut dans stderr.

--log-format format

    Format des journaux : text ou json. La valeur par défaut est text.

--log-level chaîne

    Chaîne représentant le niveau de journalisation. Si cet indicateur n’est pas défini, le niveau de format de journal est désactivé.

Type -o, --output

    Type de sortie de commande, text ou json. La valeur par défaut est text.

-p, --profile chaîne

    Nom du profil dans le ~/.databrickscfg fichier à utiliser pour exécuter la commande. Si cet indicateur n’est pas spécifié, s’il existe, le profil nommé DEFAULT est utilisé.

--progress-format format

    Format d’affichage des journaux d’activité de progression : default, append, inplace ou json

-t, --target chaîne

    Le cas échéant, la cible d’offre groupée à utiliser

Créez un profil de configuration.

Pour créer un profil de configuration, exécutez la configure commande :

databricks configure --host <workspace-url>

La commande vous invite à saisir votre jeton d’accès personnel Azure Databricks ou votre jeton Microsoft Entra ID (anciennement Azure Active Directory) associé à la <workspace-url> spécifiée :

✔ Databricks Token:

Après avoir saisi votre jeton d’accès, celui-ci est enregistré par défaut dans le fichier ~/.databrickscfg sous Linux ou macOS, ou %USERPROFILE%\.databrickscfg sous Windows. Ce fichier contient une entrée de profil de connexion par défaut nommée DEFAULT :

[DEFAULT]
host  = <workspace-url>
token = <access-token>

Pour utiliser un autre nom de profil de connexion que DEFAULT, ajoutez l'option --profile à la commande configure, par exemple :

databricks configure --host <workspace-url> --profile <profile-name>

Tip

Vous pouvez appuyer sur la touche Tab après --profile ou -p pour afficher la liste des profils de configuration existants, afin de choisir parmi eux au lieu de saisir manuellement le nom du profil.

Toute information existante d’hôte et de jeton dans le profil de connexion spécifié est remplacée par les nouvelles informations d’hôte et de jeton.