Grupo de comandos auth

Observação

Essas informações se aplicam às versões da CLI do Databricks 0.205 e superiores, que estão em Versão Prévia Pública. Para localizar sua versão da CLI do Databricks, execute databricks -v.

O grupo de comandos auth na CLI do Databricks permite que você:

• 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.
• Usar a autenticação U2M (usuário para máquina) do OAuth para autenticar a CLI do Databricks com suas contas e workspaces do Azure Databricks.
• Obtenha informações sobre quaisquer tokens de acesso OAuth que a CLI do Databricks possa ter armazenado em cache.
• Obtenha detalhes sobre a configuração que a CLI do Databricks está usando para autenticar.

Importante

Para instalar a CLI do Databricks, consulte Instalar ou atualizar a CLI do Databricks. Para configurar a autenticação na CLI do Databricks, consulte Autenticação na CLI do Databricks.

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

Listar perfis de configuração

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

databricks auth profiles

Saída (as reticências representam conteúdo omitido, para fins de brevidade):

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 workspaces para cada perfil no nível da conta e executa um comando get current user para cada perfil no nível do espaço de trabalho. 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 token de acesso. Para exibir um token de acesso, 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 padrão. Você pode alterar o caminho padrão desse arquivo definindo a variável de ambiente DATABRICKS_CONFIG_FILE. Para saber como definir variáveis de ambiente, confira a documentação do sistema operacional.

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

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 da conta do Azure Databricks ou a URL do workspace do Azure Databricks, da seguinte maneira:

databricks auth env --profile <profile-name>

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

Dica

Pressione Tab depois de --profile ou -p para visualizar uma lista de perfis de configuração disponíveis existentes para sua 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 a autenticação de token de acesso do Azure 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 --host valor, um erro será exibido, informando que ele não pode encontrar um único perfil correspondente. Por exemplo, você pode ter um perfil que tenha apenas um valor de host e outro perfil que tenha o mesmo valor de host, mas também um valor de token. 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 diferente --host. Para valores --host que são URLs de console de conta, tente especificar um valor --account-id em vez de um valor --host.

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

Autenticar com o OAuth

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

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

Obter detalhes do token de acesso OAuth

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

databricks auth token <workspace-url>

Saída:

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

Obtenha detalhes completos de autenticação

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

Se nenhuma opção for especificada, o comando auth describe segue a Ordem padrão de avaliação para credenciais e métodos 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 informações sobre um workspace específico do Azure Databricks sejam usadas, especifique a opção --host juntamente com a 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 informações sobre uma conta específica do Azure Databricks sejam usadas, especifique a opção --host juntamente com a URL do console da conta, https://accounts.azuredatabricks.net.

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 informações sobre um perfil de configuração específico do Azure Databricks sejam usadas, especifique a opção -p ou --profile juntamente 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 tokens de acesso pessoal do Azure Databricks 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