Aller au contenu principal
Dernière mise à jour le

groupe de commandesauth

remarque

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.

Le groupe de commandes auth au sein de la CLI Databricks contient des commandes liées à l'authentification, notamment les suivantes :

  • Énumérez tous les profils de configuration d'authentification disponibles.
  • Obtenir des information sur un profil de configuration d'authentification individuel.
  • Utilisez l'authentification OAuth utilisateur-machine (U2M) pour authentifier Databricks CLI avec vos comptes et workspaces Databricks.
  • Déconnectez-vous d'un profil en effaçant les jetons OAuth mis en cache et en supprimant facultativement l'entrée du profil.
  • Obtenez des informations sur les jetons d'accès OAuth que la CLI Databricks a pu mettre en cache.
  • Obtenez des détails sur la configuration utilisée par la CLI Databricks pour l'authentification.
astuce

Pour obtenir des informations sur l'utilisateur Databricks CLI actuel, exécutez databricks current-user me.

databricks auth describe​

Décrit la configuration que l'interface de ligne de commande Databricks utilise pour s'authentifier, y compris les informations d'identification et leur source. Si aucune option n'est spécifiée, la commande auth describe suit la priorité de la méthode d'authentification.

databricks auth describe [flags]

Options​

--sensitive

Inclure les champs sensibles tels que les mots de passe et les jetons dans la sortie.

Indicateurs globaux

Exemples​

L'exemple suivant décrit la configuration d'authentification actuelle :

Bash
databricks auth describe
Output
Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: default
  ✓ auth_type: <authentication-type> (from <path>/<to>/.databrickscfg config file)

Pour spécifier que des informations sur un Workspace Databricks spécifique sont utilisées, spécifiez l'option --host avec l'URL du Workspace.

Bash
databricks auth describe --host https://<workspace-instance-name>
Output
Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from --host flag)
  ✓ profile: default
  ✓ auth_type: <authentication-type>

Pour spécifier que des informations concernant un compte Databricks spécifique sont utilisées, indiquez l'option --host ainsi que l'URL de la console du compte Databricks, https://accounts.cloud.databricks.com.

Bash
databricks auth describe --host <account-console-url>
Output
Host: <account-console-url>
User: <user-name>@<domain>
AccountId: <account-id>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: <account-console-url> (from --host flag)
  ✓ account_id: <account-id>
  ✓ profile: default
  ✓ auth_type: <authentication-type>

Pour spécifier que des informations concernant un profil de configuration Databricks spécifique sont utilisées, spécifiez l'option -p ou --profile ainsi que le nom du profil :

Bash
databricks auth describe -p TEST
Output
Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: ******** (from <path>/<to>/.databrickscfg config file)
  ✓ profile: TEST (from --profile flag)
  ✓ auth_type: <authentication-type>

Pour inclure des informations sensibles dans la sortie (telles que les jetons d'accès personnels Databricks et les secrets client), spécifiez l'option --sensitive :

Bash
databricks auth describe --sensitive
Output
Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: pat
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: <token-value> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: <profile-name>
  ✓ auth_type: pat

databricks auth env​

attention

Cette commande est obsolète.

Obtenez des informations sur un profil de configuration existant en utilisant le nom du profil ou l'URL de la console de compte Databricks ou l'URL du workspace Databricks.

databricks auth env [flags]
astuce

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.

Pour créer un profil de configuration, consultez la configure commande.

Options​

--host string

Hostname pour obtenir l'environnement d'authentification

remarque

Si plusieurs profils correspondent à la valeur --host, une erreur s'affiche, indiquant qu'il ne peut pas trouver un seul profil correspondant. Par exemple, vous pourriez avoir un profil qui n'a qu'une valeur d'hôte et un autre profil qui a la même valeur d'hôte mais aussi une valeur de jeton. Dans ce cas, le Databricks CLI ne choisit pas de profil et s'arrête. Pour aider le Databricks CLI à choisir le profil souhaité, veuillez essayer de spécifier une valeur --host différente. Pour les valeurs --host qui sont des URL de console de compte, veuillez essayer de spécifier une valeur --account-id au lieu d'une valeur --host.

--profile string

Profil pour obtenir l'environnement d'authentification pour

Indicateurs globaux

Exemples​

L'exemple suivant obtient l'environnement d'authentification par default :

Bash
databricks auth env

L'exemple suivant obtient l'environnement d'authentification pour un hôte spécifique :

Bash
databricks auth env --host https://my-workspace.cloud.databricks.com

Le résultat pour un profil configuré avec l'authentification par jeton d'accès Databricks pourrait être :

JSON
{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "TEST",
    "DATABRICKS_HOST": "https://my-workspace.cloud.databricks.com",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

L'exemple suivant obtient l'environnement d'authentification pour un profil spécifique :

Bash
databricks auth env --profile my-test-environment

databricks auth login​

Connectez-vous à un Databricks Workspace ou un compte Databricks et enregistrez la configuration d'authentification dans un profil (dans ~/.databrickscfg par default). Le profil peut ensuite être utilisé pour authentifier d'autres commandes CLI Databricks à l'aide de l'indicateur --profile. Le profil peut également être utilisé pour authentifier d'autres outils Databricks qui prennent en charge l'authentification unifiée Databricks, y compris les SDK Databricks Python, Java et Go.

databricks auth login HOST [flags]

Cette commande nécessite la spécification d'une URL d'hôte Databricks (à l'aide de --host ou comme argument positionnel, ou déduite implicitement du nom de profil spécifié) et d'un nom de profil (à l'aide de --profile). Si vous ne spécifiez pas ces valeurs, il vous sera demandé des valeurs au moment de l'exécution.

Bien que cette commande vous connecte toujours à l'hôte spécifié, le comportement dépend des profils existants que vous avez définis dans votre fichier de configuration (à ~/.databrickscfg par default) :

  1. Si un profil avec le nom spécifié existe et spécifie un hôte, vous serez connecté à l'hôte spécifié par le profil. Le profil sera mis à jour pour utiliser « databricks-cli » comme type d'authentification si ce n'était pas le cas auparavant.
  2. Si un profil avec le nom spécifié existe mais ne spécifie pas d'hôte, vous serez invité à spécifier un hôte. Le profil sera mis à jour pour utiliser l'hôte spécifié. Le type d'authentification sera mis à jour en "databricks-cli" si ce n'était pas le cas auparavant.
  3. Si un profil portant le nom spécifié existe et spécifie un hôte, mais que vous spécifiez un hôte à l’aide de --host (ou en tant qu’argument positionnel HOST), le profil sera mis à jour pour utiliser le nouvel hôte spécifié. Le type d’authentification sera mis à jour en « databricks-cli » si ce n’était pas le cas auparavant.
  4. Si un profil portant le nom spécifié n’existe pas, un nouveau profil sera créé avec l’hôte spécifié. Le type d'authentification sera défini sur « databricks-cli ».

Arguments​

HOST

URL de l'hôte Databricks (facultatif)

Options​

--configure-cluster

Invites à configurer un cluster (compute classique)

--configure-serverless

Invitations à configurer le compute serverless

--timeout duration

Délai d'expiration pour la réalisation du défi de connexion dans le navigateur (default 1h0m0s)

Indicateurs globaux

Exemples​

L'exemple suivant se connecte à un Workspace Databricks :

Bash
databricks auth login

L'exemple suivant se connecte à un workspace Databricks spécifique :

Bash
databricks auth login https://my-workspace.cloud.databricks.com

L'exemple suivant se connecte avec un profil spécifique et configure les paramètres des clusters :

Bash
databricks auth login --profile my-profile --configure-cluster

L’exemple suivant définit un délai d’expiration personnalisé pour le processus de connexion :

Bash
databricks auth login --timeout 30m

databricks auth logout​

Se déconnecter d'un profil Databricks en effaçant ses jetons OAuth mis en cache. Vous devrez exécuter databricks auth login pour vous réauthentifier. Le profil reste dans le fichier de configuration (~/.databrickscfg default) sauf si vous spécifiez également --delete.

databricks auth logout [PROFILE] [flags]

Ce comportement s'applique uniquement aux profils créés avec databricks auth login (auth_type défini sur databricks-cli). Les profils qui utilisent d'autres méthodes d'authentification, telles que les jetons d'accès personnels ou les identifiants de machine à machine, ne stockent pas de jetons OAuth mis en cache, il n'y a donc rien à effacer. Si plusieurs profils partagent le même jeton mis en cache, la déconnexion de l'un n'affecte pas les autres.

Comportement de la commande :

  1. Si vous spécifiez un profil (en tant qu’argument PROFILE ou avec --profile), la commande se déconnecte de ce profil. Vous pouvez également fournir une URL d'hôte, que la commande résout en profil correspondant. Dans un terminal interactif, une confirmation est demandée, sauf si vous spécifiez également --auto-approve.
  2. Si vous omettez le profil dans un terminal interactif, la commande affiche un sélecteur de profils interrogeable. Vous pouvez rechercher par nom de profil, hôte ou ID de compte. Après avoir sélectionné un profil, la commande demande une confirmation, sauf si vous spécifiez également --auto-approve.
  3. Si vous omettez le profil dans un environnement non interactif, la commande échoue et vous demande de spécifier un profil.
  4. Dans un environnement non interactif, spécifiez un profil avec --auto-approve pour ignorer la confirmation.

Arguments​

PROFILE

Nom du profil ou URL de l'hôte pour se déconnecter (facultatif). L'argument est d'abord mis en correspondance avec les noms de profils existants. Si aucun profil ne correspond et que l'argument ressemble à une URL d'hôte, la commande le résout en fonction du ou des profils configurés pour cet hôte. Si plusieurs profils correspondent à un hôte, la commande vous invite à en sélectionner un (ou génère des erreurs en mode non interactif).

Options​

--delete

Supprimez également le profil du fichier de configuration (~/.databrickscfg par default)

--auto-approve

Ignorer l’invite de confirmation

Indicateurs globaux

Exemples​

L'exemple suivant déconnecte un profil spécifique :

Bash
databricks auth logout my-profile

L'exemple suivant se déconnecte du profil associé à une URL d'hôte :

Bash
databricks auth logout https://my-workspace.cloud.databricks.com

L'exemple suivant se déconnecte et supprime le profil du fichier de configuration :

Bash
databricks auth logout --profile my-profile --delete

L'exemple suivant se déconnecte sans invite de confirmation, adapté à CI/CD :

Bash
databricks auth logout my-profile --auto-approve

Profils d'authentification Databricks​

Listez tous les profils de configuration disponibles (à ~/.databrickscfg par default) et vérifiez s'il s'agit de profils valides.

databricks auth profiles [flags]

Cette commande produit des profils au format suivant :

Name            Host                Valid
DEFAULT         https://<host-url>  YES
<profile-name>  https://<host-url>  NO

Pour déterminer si chaque profil est valide, le Databricks CLI répertorie les workspaces pour chaque profil au niveau du compte et exécute une commande get current user pour chaque profil au niveau du workspace. Si la commande réussit, YES est affiché ; sinon, NO s'affiche.

La sortie de la commande auth profiles n'affiche aucun jeton d'accès. Pour afficher un jeton d'accès, consultez databricks auth env.

Par default, les profils de configuration sont stockés dans le fichier ~/.databrickscfg sur Linux ou macOS, ou %USERPROFILE%\.databrickscfg sur Windows. Vous pouvez modifier le chemin par default de ce fichier en définissant la variable d’environnement DATABRICKS_CONFIG_FILE.

Pour créer des profils de configuration, consultez la commandeconfigure.

Options​

--skip-validate

S'il faut ignorer la validation des profils

Indicateurs globaux

Exemples​

L'exemple suivant répertorie tous les profils d'authentification :

Bash
databricks auth profiles

L'exemple suivant liste les profils sans les valider :

Bash
databricks auth profiles --skip-validate

databricks auth switch​

Définissez un profil nommé comme default dans ~/.databrickscfg. Le nom de profil sélectionné est stocké dans une section [__settings__] du fichier de configuration sous la clé default_profile. Utilisez databricks auth profiles pour voir quel profil est le default.

databricks auth switch [flags]

Options​

Indicateurs globaux

Exemples​

L’exemple suivant sélectionne de manière interactive un profil à définir comme default :

Bash
databricks auth switch

L'exemple suivant définit un profil spécifique comme profil default :

Bash
databricks auth switch --profile my-profile

jeton d'authentification Databricks​

Obtenez le jeton d'authentification à partir du cache local dans ~/.databricks/token-cache.json. refresh le jeton d'accès s'il est expiré ou proche de l'expiration. Cette commande ne fonctionne qu'avec l'authentication U2M (à l'aide de la commande databricks auth login). L'authentification M2M utilisant un ID client et un secret n'est pas prise en charge.

databricks auth token [HOST_OR_PROFILE] [flags]

Pour configurer et mettre en place l’authentification OAuth U2M, consultez l’authentification OAuth utilisateur-machine (U2M).

Arguments​

HOST_OR_PROFILE

URL d'hôte Databricks ou nom de profil (facultatif)

Options​

--account-id string

ID de compte Databricks

--force-refresh

Forcer le refresh d'un jeton même si le jeton mis en cache est toujours valide.

--timeout duration

Délai d'expiration pour l'acquisition d'un jeton. (default 1h0m0s)

Indicateurs globaux

Exemples​

L'exemple suivant obtient le jeton d'authentification :

Bash
databricks auth token

L'exemple suivant obtient le jeton d'authentification pour un hôte spécifique :

Bash
databricks auth token https://my-workspace.cloud.databricks.com

Le résultat pourrait être :

JSON
{
  "access_token": "<token-value>",
  "token_type": "Bearer",
  "expiry": "<token-expiration-date-time>"
}

L'exemple suivant définit un délai d'expiration personnalisé pour l'acquisition de jetons :

Bash
databricks auth token --timeout 30m

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

Sur cette page