`auth` grupo de comando

Observação

Esta informação se aplica às versões 0.205 e acima do Databricks CLI, que estão em Public Preview. Para encontrar sua versão da CLI do Databricks, execute databricks -v.

O grupo de comandos auth na CLI do Databricks permite:

Liste todos os perfis de configuração de autenticação disponíveis.
Obtenha informações sobre um perfil de configuração de autenticação individual.
Use a autenticação de usuário para máquina (U2M) OAuth para autenticar a CLI do Databricks com sua account e workspace do Databricks.
Obtenha informações sobre qualquer access token OAuth que a CLI do Databricks possa ter armazenado em cache.
Obtenha detalhes sobre a configuração que a CLI da Databricks está usando para autenticar.

Importante

Antes de usar a CLI do Databricks, certifique-se de configurar a CLI do Databricks e configurar a autenticação para a CLI do Databricks.

Você executa auth comandos anexando-os a databricks auth. Para exibir ajuda para o comando auth , execução databricks auth -h.

Listar perfis de configuração

Para obter uma lista de todos os seus perfis de configuração disponíveis e verificar se eles são válidos, execute o comando auth profiles da seguinte maneira:

databricks auth profiles

Saída (as reticências representam o conteúdo omitido, para abreviar):

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

Para determinar se cada perfil é válido, a CLI do Databricks executa um comando list workspace para cada perfil de nível de accounte executa um comando get current user para cada perfil de nível de workspace . Se o comando for bem-sucedido, um YES será exibido; caso contrário, um NO será exibido.

A saída do comando auth profiles não exibe nenhum access token. Para exibir access tokens, consulte Obter informações sobre um perfil de configuração.

Os perfis de configuração são armazenados no arquivo ~/.databrickscfg no Linux ou macOS ou %USERPROFILE%\.databrickscfg no Windows por default. Você pode alterar o caminho default desse arquivo definindo a variável de ambiente DATABRICKS_CONFIG_FILE. Para saber como definir a variável de ambiente, consulte a documentação do seu sistema operacional.

Para criar perfis de configuração, consulte o grupo de comandos configure.

Obter informações sobre um perfil de configuração

Para obter informações sobre um perfil de configuração existente, execute o comando auth env, em que <profile-name> representa o nome do perfil e <account-or-workspace-url> representa a URL do console account do Databricks ou a URL workspace do Databricks, da seguinte maneira:

databricks auth env --profile <profile-name>

# Or:
databricks auth env --host <account-or-workspace-url>

Dica

Você pode pressionar Tab após --profile ou -p para exibir uma lista de perfis de configuração existentes disponíveis para escolha, em vez de inserir o nome do perfil de configuração manualmente.

Por exemplo, aqui está a saída para um perfil configurado com autenticação access tokens Databricks:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "<profile-name>",
    "DATABRICKS_HOST": "<workspace-url>",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

Observação

Se mais de um perfil corresponder ao valor --host , um erro será exibido, informando que não foi possível encontrar um único perfil correspondente. Por exemplo, você pode ter um perfil que possui apenas um valor de host e outro perfil que possui o mesmo valor de host, mas também um valor tokens . Nesse caso, a CLI do Databricks não escolhe um perfil e para. Para ajudar a CLI do Databricks a escolher o perfil desejado, tente especificar um valor --host diferente. Para valores --host que são URLs do console account , tente especificar um valor --account-id em vez de um valor --host.

Para criar um perfil de configuração, consulte o grupo de comando configure.

Autenticar com OAuth

Em vez de autenticar com Databricks usando access token e perfis de configuração, você pode usar a autenticação usuário-máquina (U2M) OAuth. OAuth fornece tokens com tempos de expiração mais rápidos do que access token pessoal do Databricks e oferece melhor invalidação e escopo de sessão do lado do servidor. Como access token OAuth expira em menos de uma hora, isso reduz o risco associado à verificação acidental de tokens no controle de origem. Consulte Autenticação usuário-máquina (U2M) OAuth.

Para configurar e configurar a autenticação OAuth U2M, consulte Autenticação usuário-máquina (U2M) OAuth.

Obter detalhes access tokens OAuth

Se você quiser ver informações sobre os access tokens OAuth em cache que a CLI do Databricks gerou anteriormente para um workspace do Databricks, execute o comando auth token, em que <workspace-url> representa a URL do workspace do Databricks, da seguinte maneira:

databricks auth token <workspace-url>

Saída:

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

Obter detalhes de autenticação

Para obter detalhes sobre a configuração que o Databricks CLI está usando para autenticar, execute o comando auth describe.

Se nenhuma opção for especificada, o comando auth describe seguirá a ordem de avaliaçãodefault para métodos e credenciais de autenticação unificada do cliente.

databricks auth describe

Saída:

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)

Para especificar que as informações sobre um Databricks workspace específico sejam usadas, especifique a opção --host junto com o URL do workspace.

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

Saída:

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>

Para especificar que as informações sobre um Databricks account específico sejam usadas, especifique a opção --host junto com o URL do console Databricks account , https://accounts.cloud.databricks.com.

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

Saída:

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>

Para especificar que as informações sobre um perfil de configuração específico do Databricks sejam usadas, especifique a opção -p ou --profile junto com o nome do perfil.

databricks auth describe -p <profile-name>

Saída:

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: <profile-name> (from --profile flag)
  ✓ auth_type: <authentication-type>

Para incluir informações confidenciais na saída (como Databricks personal access tokens e segredos do cliente), especifique a opção --sensitive.

databricks auth describe --sensitive

Saída:

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

auth grupo de comando

Listar perfis de configuração

Obter informações sobre um perfil de configuração

Autenticar com OAuth

Obter detalhes access tokens OAuth

Obter detalhes de autenticação

`auth` grupo de comando