Partager via

auth groupe de commande

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.

Le auth groupe de commandes dans l’interface CLI Databricks contient des commandes associées à l’authentification, notamment les suivantes :

  • Lister les profils de configuration d’authentification disponibles.
  • Obtenir des informations sur un profil de configuration d’authentification individuel.
  • Utiliser l’authentification utilisateur à machine (U2M) OAuth pour authentifier l’interface CLI Databricks auprès de vos comptes et de vos espaces de travail Azure Databricks.
  • Obtenir des informations sur les jetons d’accès OAuth que l’interface CLI Databricks peut avoir mis en cache.
  • Obtenez des détails sur la configuration utilisée par l’interface CLI Databricks pour l’authentification.

Tip

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

databricks auth décrivent

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

databricks auth describe [flags]

Paramètres

--sensitive

    Inclure des 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 :

databricks auth describe

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 indiquer que les informations concernant un espace de travail Azure Databricks spécifique sont utilisées, spécifiez l’option --host avec l’URL de l’espace de travail.

databricks auth describe --host https://<workspace-instance-name>

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 préciser ces informations sur un compte Azure Databricks spécifique, précisez l’option --host ainsi que l’URL de la console de compte Azure Databricks, https://accounts.azuredatabricks.net.

databricks auth describe --host <account-console-url>

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 ces informations sur un profil de configuration Azure Databricks spécifique, spécifiez l’option ou -p le --profile nom du profil :

databricks auth describe -p TEST

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 Azure Databricks et les secrets client), spécifiez l’option --sensitive suivante :

databricks auth describe --sensitive

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

environnement d'authentification Databricks

Obtenez des informations sur un profil de configuration existant à l’aide du nom du profil ou de l’URL de la console de compte Azure Databricks ou de l’URL de l’espace de travail Azure Databricks.

databricks auth env [flags]

Tip

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 créer un profil de configuration, consultez la configure commande.

Paramètres

--host string

    Nom d’hôte pour obtenir l’authentification pour

Note

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 pouvez avoir un profil qui a uniquement 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, l’interface CLI Databricks ne choisit pas de profil et s’arrête. Pour aider l’interface CLI Databricks à choisir le profil souhaité, essayez de spécifier une autre valeur --host. Pour les valeurs --host qui sont des URL de console de compte, essayez de spécifier une valeur --account-id au lieu d’une valeur --host.

--profile string

    Profil pour obtenir l’authentification pour

Indicateurs globaux

Exemples

L’exemple suivant obtient l’environnement d’authentification par défaut :

databricks auth env

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

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

La sortie d’un profil configuré avec l’authentification par jeton d’accès Azure Databricks peut être :

{
  "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 :

databricks auth env --profile my-test-environment

connexion d’authentification databricks

Connectez-vous à un espace de travail ou un compte Databricks et enregistrez la configuration d’authentification dans un profil (par ~/.databrickscfg défaut). 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, notamment les Kits de développement logiciel (SDK) Databricks Python, Java et Go.

databricks auth login HOST [flags]

Cette commande nécessite une URL d’hôte Databricks (en utilisant --host ou en tant qu’argument positionnel ou implicitement déduit du nom de profil spécifié) et un nom de profil (utilisant --profile) à spécifier. Si vous ne spécifiez pas ces valeurs, vous êtes invité à entrer des valeurs au moment de l’exécution.

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

  1. Si un profil portant le nom spécifié existe et spécifie un hôte, vous êtes 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 avant.
  2. Si un profil portant 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 est mis à jour sur « databricks-cli » si ce n’était pas le cas avant.
  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 --host (ou en tant qu’argument HOST positionnel), le profil est mis à jour pour utiliser l’hôte nouvellement spécifié. Le type d’authentification est mis à jour sur « databricks-cli » si ce n’était pas le cas avant.
  4. Si un profil portant le nom spécifié n’existe pas, un nouveau profil est créé avec l’hôte spécifié. Le type d’authentification est défini sur « databricks-cli ».

Les arguments

HOST

    URL de l’hôte Databricks (facultatif)

Paramètres

--configure-cluster

    Invites pour configurer le cluster (calcul classique)

--configure-serverless

    Instructions pour configurer le calcul sans serveur

--timeout duration

    Délai d’expiration de la tâche de connexion dans le navigateur (par défaut 1h00m0)

Indicateurs globaux

Exemples

L’exemple suivant se connecte à un espace de travail Databricks :

databricks auth login

L’exemple suivant se connecte à un espace de travail Databricks spécifique :

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

L’exemple suivant se connecte avec un profil spécifique et configure les paramètres du cluster :

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

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

databricks auth login --timeout 30m

profils d’authentification databricks

Répertoriez tous les profils de configuration disponibles (par ~/.databrickscfg défaut) et vérifiez s’ils sont des profils valides.

databricks auth profiles [flags]

Cette commande génère 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, l’interface CLI Databricks répertorie les espaces de travail pour chaque profil au niveau du compte et exécute une commande d’utilisateur get current pour chaque profil au niveau de l’espace de travail. Si la commande réussit, YES est affichée ; sinon, NO est affichée.

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

Par défaut, 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 défaut de ce fichier en définissant la variable d'environnement DATABRICKS_CONFIG_FILE.

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

Paramètres

--skip-validate

    Indique s’il faut ignorer la validation des profils

Indicateurs globaux

Exemples

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

databricks auth profiles

L’exemple suivant répertorie les profils sans les valider :

databricks auth profiles --skip-validate

jeton d’authentification databricks

Obtenez le jeton d’authentification à partir du cache local dans ~/.databricks/token-cache.json. Actualisez le jeton d’accès s’il a expiré. Cette commande fonctionne uniquement avec l’authentification U2M (à l’aide de la databricks auth login commande). L’authentification M2M à l’aide d’un ID client et d’un secret n’est pas prise en charge.

databricks auth token [HOST] [flags]

Pour configurer l’authentification OAuth U2M, consultez l’authentification utilisateur-vers-machine OAuth (U2M).

Les arguments

HOST

    URL de l’hôte Databricks (facultatif)

Paramètres

--account-id string

    ID de compte Databricks

--timeout duration

    Délai d’expiration pour l’acquisition d’un jeton. (par défaut 1h0m0s)

Indicateurs globaux

Exemples

L’exemple suivant obtient le jeton d’authentification :

databricks auth token

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

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

La sortie peut être :

{
  "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 :

databricks auth token --timeout 30m

Indicateurs globaux

--debug

  Faut-il activer 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 de caractères

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

--log-format format

    Type de format de journal : text ou json. La valeur par défaut est text.

--log-level chaîne de caractères

    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 de caractères

    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 permettant d’afficher les journaux de progression : default, append, inplace ou json

-t, --target chaîne de caractères

    Le cas échéant, la cible d'ensemble à utiliser

  • Last updated on