Compartilhar via


Autentique-se com tokens de acesso pessoal do Azure Databricks (legado)

Os PATs (tokens de acesso pessoal) do Azure Databricks permitem que você se autentique em recursos e APIs no nível do workspace. Você pode armazená-las em variáveis de ambiente ou perfis de configuração do Azure Databricks. Cada PAT é válido para apenas um workspace e um usuário pode criar até 600 PATs por workspace. O Azure Databricks revoga automaticamente PATs que não são usadas há 90 dias.

Importante

A autenticação de nome de usuário e senha (sem tokens) atingiu o fim da vida útil em 10 de julho de 2024. O Databricks recomenda fortemente o uso do OAuth em vez de PATs para autenticação de conta de usuário, pois o OAuth fornece segurança mais forte. Para saber como autenticar com uma conta de usuário do Databricks usando o OAuth, consulte Autorizar o acesso do usuário ao Azure Databricks com o OAuth.

Você não pode usar tokens de acesso pessoal para automatizar a funcionalidade de nível de conta do Azure Databricks. Em vez disso, use os tokens de ID do Microsoft Entra dos administradores de conta do Azure Databricks. Os administradores de conta do Azure Databricks podem ser usuários ou entidades de serviço. Para obter mais informações, consulte:

Criar tokens de acesso pessoal para usuários do workspace

Para criar um token de acesso pessoal para o usuário do workspace do Azure Databricks, faça o seguinte:

  1. No workspace do Azure Databricks, clique no nome de usuário na barra superior e selecione Configurações.

  2. Clique em Desenvolvedor.

  3. Ao lado de Tokens de acesso, clique em Gerenciar.

  4. Clique em Gerar novo token.

  5. Insira um comentário que ajude você a identificar esse token no futuro.

  6. Defina o tempo de vida do token em dias. Veja Definir o tempo de vida máximo de novos tokens de acesso pessoal.

  7. Clique em Gerar.

  8. Copie o token exibido para um local seguro e clique em Concluído. Salve o token com segurança e não compartilhe-o. Se você perdê-lo, deverá criar um novo token.

Se você não puder criar ou usar tokens, o administrador do workspace poderá ter desabilitado tokens ou não concedido permissão. Veja o administrador do workspace ou o seguinte:

Criar tokens de acesso pessoal para entidades de serviço

Um principal de serviço pode criar tokens de acesso pessoal para si mesmo.

  1. Execute o seguinte comando para gerar um token de acesso:

    databricks tokens create --lifetime-seconds <lifetime-seconds> -p <profile-name>
    

    Substitua os seguintes valores:

    • <lifetime-seconds>: tempo de vida do token em segundos, como 86400 por 1 dia. O padrão é o limite máximo do espaço de trabalho (normalmente 730 dias).
    • <profile-name>: perfil de configuração com informações de autenticação. Usa DEFAULT como padrão.
  2. Copie token_value da resposta, que é o token de acesso para sua entidade de serviço. Salve o token com segurança e não compartilhe-o. Se você perdê-lo, deverá criar um novo token.

Se você não puder criar ou usar tokens, o administrador do workspace poderá ter desabilitado tokens ou não concedido permissão. Veja o administrador do workspace ou o seguinte:

Executar autenticação de token de acesso pessoal

Para configurar a autenticação de token de acesso pessoal do Azure Databricks, defina as seguintes variáveis de ambiente associadas: os .databrickscfg campos, os campos do Terraform ou os Config campos.

  • O host do Azure Databricks, especificado como a URL por workspace de destino do Azure Databricks, por exemplo, https://adb-1234567890123456.7.azuredatabricks.net.
  • O token de acesso pessoal do Azure Databricks para a conta de usuário do Azure Databricks.

Para executar a autenticação de token de acesso pessoal do Azure Databricks, integre o seguinte em seu código, com base na ferramenta ou SDK participante:

Ambiente

Para usar variáveis de ambiente para um tipo de autenticação específico do Azure Databricks com uma ferramenta ou SDK, consulte Autorizar o acesso aos recursos do Azure Databricks ou à documentação da ferramenta ou do SDK. Consulte também variáveis de ambiente e campos para autenticação unificada e a prioridade do método de autenticação.

Defina as seguintes variáveis de ambiente:

  • DATABRICKS_HOST, defina a URL por workspace do Azure Databricks, por exemplo https://adb-1234567890123456.7.azuredatabricks.net.
  • DATABRICKS_TOKEN, definido como a cadeia de caracteres de token.

Perfil

Crie ou identifique um perfil de configuração do Azure Databricks com os seguintes campos em seu arquivo do .databrickscfg. Se você criar o perfil, substitua os espaços reservados pelos valores apropriados. Para usar o perfil com uma ferramenta ou SDK, consulte Autorizar o acesso aos recursos do Azure Databricks ou à documentação da ferramenta ou do SDK. Consulte também variáveis de ambiente e campos para autenticação unificada e a prioridade do método de autenticação.

Defina os seguintes valores em seu arquivo .databrickscfg. Nesse caso, o host é a URL de cada espaço de trabalho do Azure Databricks, por exemplo https://adb-1234567890123456.7.azuredatabricks.net:

[<some-unique-configuration-profile-name>]
host  = <workspace-url>
token = <token>

Em vez de definir manualmente os valores, você pode usar a CLI do Databricks para definir esses valores em vez disso:

Observação

O procedimento a seguir usa a CLI do Databricks para criar um perfil de configuração do Azure Databricks com o nome DEFAULT. Se você já tiver um perfil de configuração DEFAULT, esse procedimento irá substituir seu perfil de configuração DEFAULT existente.

Para verificar se você já tem um DEFAULT perfil de configuração e exibir as configurações desse perfil se ele existir, use a CLI do Databricks para executar o comando databricks auth env --profile DEFAULT.

Para criar um perfil de configuração com um nome diferente de DEFAULT, substitua a parte DEFAULT de --profile DEFAULT no seguinte comando databricks configure por um nome diferente do perfil de configuração.

  1. Use a CLI do Databricks para criar um perfil de configuração do Azure Databricks chamado DEFAULT com autenticação por token de acesso pessoal do Azure Databricks. Para fazer isso, execute o seguinte comando:

    databricks configure --profile DEFAULT
    
  2. Para o prompt Host do Databricks, insira a URL por espaço de trabalho do Azure Databricks, por exemplo, https://adb-1234567890123456.7.azuredatabricks.net.

  3. Para o prompt Token de Acesso Pessoal, insira o token de acesso pessoal do Azure Databricks para seu espaço de trabalho.

CLI

Para a CLI da Databricks, execute o comando databricks configure. Nas solicitações, insira as seguintes configurações:

  • O host do Azure Databricks, especificado como a URL por workspace de destino do Azure Databricks, por exemplo, https://adb-1234567890123456.7.azuredatabricks.net.
  • O token de acesso pessoal do Azure Databricks para a conta de usuário do Azure Databricks.

Para obter mais informações, consulte Autenticação de token de acesso pessoal (preterida).

Conectar

Observação

A autenticação do token de acesso pessoal do Azure Databricks tem suporte nas seguintes versões do Databricks Connect:

  • Para Python, o Databricks Connect para Databricks Runtime 13.3 LTS e versões superiores.
  • Para o Scala, o Databricks Connect para Databricks Runtime 13.3 LTS e superior.

Para o Databricks Connect, use a CLI do Databricks para definir os valores no arquivo .databrickscfg para operações no nível do workspace do Azure Databricks, como especificado na seção Perfil.

O procedimento a seguir cria um perfil de configuração do Azure Databricks chamado DEFAULT, que substitui qualquer perfil existente DEFAULT . Para verificar se existe um DEFAULT perfil, execute databricks auth env --profile DEFAULT. Se existir, use um nome de perfil diferente.

  1. Execute o comando a seguir para criar um perfil de configuração do Azure Databricks chamado DEFAULT que usa a autenticação de token de acesso pessoal.

    databricks configure --configure-cluster --profile DEFAULT
    
  2. Para o prompt Host do Databricks, insira a URL por espaço de trabalho do Azure Databricks, por exemplo, https://adb-1234567890123456.7.azuredatabricks.net.

  3. Para o campo Token de Acesso Pessoal, insira o token de acesso pessoal para seu espaço de trabalho.

  4. Na lista de clusters disponíveis, selecione o cluster de destino do Azure Databricks em seu workspace. Você pode digitar qualquer parte do nome de exibição do cluster para filtrar a lista de clusters disponíveis.

Usar a API REST do Azure Databricks para emitir tokens de acesso pessoal

O Azure Databricks fornece um endpoint REST /api/2.0/token/create para emitir tokens de acesso pessoal (PATs). Consulte Criar um token de usuário para obter detalhes da API.

No exemplo a seguir, defina estes valores:

  • <databricks-instance>: a URL do workspace do Databricks. Por exemplo, dbc-abcd1234-5678.cloud.databricks.com.
  • <your-existing-access-token>: um PAT (cadeia de caracteres) válido existente que tem permissões para criar novos tokens.
  • <lifetime-seconds>: o tempo de vida do token em segundos.
curl -X POST https://<databricks-instance>/api/2.0/token/create \
-H "Authorization: Bearer <your-existing-access-token>" \
-H "Content-Type: application/json" \
-d '{
  "lifetime_seconds": <lifetime-seconds>
}'

Se for bem-sucedido, isso resultará em uma carga de resposta semelhante a:

{
  "access_token": "<your-newly-issued-pat>",
  "token_type": "Bearer",
  "expires_in": <the-duration-of-the-new-pat>
}

Coloque o novo token da resposta no cabeçalho de autorização de chamadas subsequentes para as APIs REST do Databricks. Por exemplo:

# This example uses a simple GET. For POST or other REST verbs, you may need to provide additional parameters.
curl -X GET "https://<databricks-instance>/api/2.0/<path-to-endpoint>" \
     -H "Authorization: Bearer <your-new-pat>"
import requests

headers = {
    'Authorization': 'Bearer <your-new-pat>'
}
# This example is for an HTTP GET operation.
response = requests.get('https://<databricks-instance>/api/2.0/<path-to-endpoint>', headers=headers)