Partilhar via

auth grupo de comando

  • Artigo

Nota

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer disposições de Dados de Uso.

O auth grupo de comandos dentro da 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.
  • Use a autenticação de usuário para máquina (U2M) OAuth para autenticar a CLI do Databricks com suas contas e espaços de trabalho 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.

Execute auth comandos anexando-os ao databricks auth. Para exibir a ajuda para o auth comando, execute 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 auth profiles comando, da seguinte maneira:

databricks auth profiles

Saída (as reticências representam conteúdo omitido, para 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 será exibido, caso YES contrário, um NO será exibido.

A saída do comando não exibe nenhum token de auth profiles 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 DATABRICKS_CONFIG_FILEde ambiente . Para saber como definir variáveis 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 auth env comando, onde <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 espaço de trabalho do Azure Databricks, da seguinte maneira:

databricks auth env --profile <profile-name>

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

Gorjeta

Você pode pressionar Tab depois --profile ou -p para exibir uma lista de perfis de configuração disponíveis existentes para escolher, 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>"
  }
}

Nota

Se mais de um perfil corresponder ao --host valor, será exibido um erro, informando que não é possível 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 --host valores que são URLs de console de conta, tente especificar um --account-id valor em vez de um --host valor.

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

Autenticar com OAuth

Em vez de autenticar com o Azure Databricks usando tokens de acesso e perfis de configuração, você pode usar a autenticação de usuário para máquina (U2M) 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 Autenticar o acesso ao Azure Databricks com uma conta de usuário usando OAuth (OAuth U2M).

Para configurar e configurar a autenticação U2M do OAuth, consulte Autenticação de usuário para máquina (U2M) 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 espaço de trabalho do Azure Databricks, execute o auth token comando, onde <workspace-url> representa a URL do espaço de trabalho 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>"
}

Obter detalhes de autenticação

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

Se nenhuma opção for especificada, o comando seguirá auth describe os métodos padrão para 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 espaço de trabalho específico do Azure Databricks são usadas, especifique a --host opção junto com a URL do espaço de trabalho.

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 uma conta específica do Azure Databricks são usadas, especifique a --host opção junto com a URL do console da conta do Azure Databricks, 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 as informações sobre um perfil de configuração específico do Azure Databricks sejam usadas, especifique a -p opção 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 tokens de acesso pessoal e segredos de cliente do Azure Databricks), especifique a --sensitive opção.

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