Autenticação de token de acesso pessoal do Databricks

access token pessoal do Databricks é um dos tipos de credenciais mais bem suportados para recursos e operações no nível do workspace do Databricks. Muitos mecanismos de armazenamento de credenciais e informações relacionadas, como variáveis de ambiente e perfis de configuração do Databricks, fornecem suporte para access token pessoal do Databricks. Embora os usuários possam ter vários access token pessoal em um workspace do Databricks, cada access token pessoal funciona apenas para um único workspace do Databricks. O número de access token pessoal por usuário é limitado a 600 por workspace.

Observação

Para automatizar a funcionalidade no nível account do Databricks, você não pode usar access token pessoal do Databricks. Em vez disso, você deve utilizar tokens OAuth para administradores de contas no Databricks ou princípios de serviço, ou o nome de usuário e a senha de administradores de nível de conta no Databricks.Para mais informações, consulte:

Tokens de acesso pessoal do Databricks para usuários do workspace

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

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

  2. Clique em Desenvolvedor.

  3. Ao lado do access token, clique em gerenciar.

  4. Clique em Gerar novos tokens.

  5. (Opcional) Insira um comentário que o ajude a identificar esse token no futuro e altere o tempo de vida padrão do token de 90 dias. Para criar um token sem vida útil (não recomendado), deixe a caixa Duração (dias) vazia (em branco).

  6. Clique em Gerar.

  7. Copie o token exibido em um local seguro e clique em Concluído.

Observação

Não se esqueça de salvar os tokens copiados em um local seguro. Não compartilhe seus tokens copiados com outras pessoas. Se o senhor perder os tokens copiados, não poderá regenerar exatamente os mesmos tokens. Em vez disso, o senhor deve repetir esse procedimento para criar novos tokens. Se o senhor perder os tokens copiados ou acreditar que os tokens foram comprometidos, a Databricks recomenda enfaticamente que o senhor exclua imediatamente esses tokens do seu site workspace clicando no ícone da lixeira(Revoke) ao lado dos tokens na página do token de acesso.

Se não for possível criar ou usar tokens no seu workspace, isso pode ocorrer porque o administrador do workspace desativou os tokens ou não lhe deu permissão para criar ou usar tokens. Consulte o administrador do workspace ou o seguinte:

Tokens de acesso pessoal do Databricks para entidades de serviço

Um administrador de workspace pode criar um token de acesso pessoal da Databricks em nome de uma entidade de serviço, como segue:

Observação

O senhor não pode usar a interface de usuário da Databricks para gerar o token de acesso pessoal da Databricks para a entidade de serviço da Databricks. Esse processo usa o Databricks CLI versão 0.205 ou superior para gerar um access token para uma entidade de serviço do Databricks. Se o senhor ainda não tiver a CLI da Databricks instalada, consulte Instalar ou atualizar a CLI da Databricks.

  1. Configure a autenticação para a CLI do Databricks, se o senhor ainda não tiver feito isso. Uma maneira de configurar isso é usar primeiro a autenticação pessoal do Databricks access token para o usuário do Databricks workspace. Consulte a autenticação pessoal do Databricks access token .

  2. Obtenha o ID do aplicativo para a entidade de serviço Databricks, se o senhor ainda não o tiver disponível:

    1. Se o console de administração do seu workspace ainda não estiver aberto, clique no seu nome de usuário na barra superior do workspacee clique em Admin Settings.

    2. Em workspace admin, clique em Identity and access (Identidade e acesso).

    3. Ao lado de entidade de serviço, clique em gerenciar.

    4. Clique no nome da entidade de serviço Databricks para abrir sua página de configurações. Se o nome não estiver visível, use Filtrar entidade de serviço para encontrá-lo.

    5. Em Configurations (Configurações ) tab, observe o valor do Application Id (ID do aplicativo ).

  3. Use a CLI da Databricks para executar o seguinte comando, que gera o access token para a entidade de serviço da Databricks.

    No comando a seguir, substitua esses espaços reservados:

    • Substitua <application-id> pelo ID do aplicativo da entidade de serviço Databricks.

    • Substitua <lifetime-seconds> pelo número de segundos pelo qual o access token é válido. Por exemplo, 1 dia equivale a 86400 segundos.

    • Opcionalmente, substitua <comment> por qualquer comentário significativo sobre a finalidade do access token. Se a opção --comment não for especificada, nenhum comentário será gerado.

    • Opcionalmente, substitua <profile-name> pelo nome de um perfil de configuração do Databricks que contenha informações de autenticação para o usuário e o destino do Databricks workspace. Por exemplo, consulte a autenticação pessoal da Databricks em access token . Se a opção -p não for especificada, a CLI do Databricks tentará localizar e usar um perfil de configuração denominado DEFAULT.

    databricks token-management create-obo-token <application-id> --lifetime-seconds <lifetime-seconds> --comment <comment> -p <profile-name>
    
  4. Na resposta, copie o valor de token_value, que é o access token da entidade de serviço do Databricks.

    É importante que você salve o token copiado em um local seguro. Não compartilhe seu token copiado com outras pessoas. Se você perder o token copiado, não poderá gerar de novo exatamente o mesmo token. Em vez disso, você deverá repetir o procedimento para criar outro token.

    Se não for possível criar ou usar tokens no seu workspace, isso pode ocorrer porque o administrador do workspace desativou os tokens ou não lhe deu permissão para criar ou usar tokens. Consulte o administrador do workspace ou o seguinte:

Uma entidade de serviço pode, então, usar seu próprio access token pessoal da Databricks para criar um token de acesso pessoal adicional da Databricks para si mesma, como segue:

Observação

O senhor não pode usar a interface de usuário da Databricks para gerar o token de acesso pessoal da Databricks para a entidade de serviço da Databricks. Esse processo usa o Databricks CLI versão 0.205 ou superior para gerar um access token para uma entidade de serviço do Databricks. Se o senhor ainda não tiver a CLI da Databricks instalada, consulte Instalar ou atualizar a CLI da Databricks.

Este procedimento pressupõe que o senhor já tenha gerado o primeiro Databricks pessoal access token para a entidade de serviço Databricks. O senhor usa esse access token para configurar a CLI da Databricks para autenticar a entidade de serviço da Databricks, de modo que ela possa gerar um token de acesso adicional para si mesma. Consulte a autenticação pessoal do Databricks access token .

  1. Use a CLI do Databricks para executar o seguinte comando, que gera outro access token para a entidade de serviço do Databricks.

    No comando a seguir, substitua esses espaços reservados:

    • Opcionalmente, substitua <comment> por qualquer comentário significativo sobre a finalidade do access token. Se a opção --comment não for especificada, nenhum comentário será gerado.

    • Opcionalmente, substitua <lifetime-seconds> pelo número de segundos para os quais o access token é válido. Por exemplo, 1 dia equivale a 86400 segundos. Se a opção --lifetime-seconds não for especificada, o site access token será definido para nunca expirar (não recomendado).

    • Opcionalmente, substitua <profile-name> pelo nome de um perfil de configuração do Databricks que contenha informações de autenticação para a entidade de serviço do Databricks e o destino workspace. Se a opção -p não for especificada, a CLI do Databricks tentará localizar e usar um perfil de configuração denominado DEFAULT.

    databricks tokens create --comment <comment> --lifetime-seconds <lifetime-seconds> -p <profile-name>
    
  2. Na resposta, copie o valor de token_value, que é o access token para a entidade de serviço Databricks.

    É importante que você salve o token copiado em um local seguro. Não compartilhe seu token copiado com outras pessoas. Se você perder o token copiado, não poderá gerar de novo exatamente o mesmo token. Em vez disso, você deverá repetir o procedimento para criar outro token.

    Se não for possível criar ou usar tokens no seu workspace, isso pode ocorrer porque o administrador do workspace desativou os tokens ou não lhe deu permissão para criar ou usar tokens. Consulte o administrador do workspace ou o seguinte:

Executar autenticação de token de acesso pessoal do Databricks

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

  • O host do Databricks, especificado como a URL do espaço de trabalho do Databricks de destino, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com.

  • O token de acesso pessoal do Databricks, para a conta de usuário do Databricks ou principal do serviço do Databricks.

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

Para utilizar a variável de ambiente para um tipo específico de autenticação Databricks com uma ferramenta ou SDK, consulte Tipos de autenticação suportados pela ferramenta ou SDK Databricks ou a documentação da ferramenta ou do SDK. Consulte também variável de ambiente e campos para autenticação unificada do cliente e a ordemdefault de avaliação para métodos e credenciais de autenticação unificada do cliente.

Defina as seguintes variáveis de ambiente:

  • DATABRICKS_HOST, defina como a URL do espaço de trabalho do Databricks, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com.

  • DATABRICKS_TOKEN

Crie ou identifique um perfil de configuração do Databricks com os campos a seguir em seu arquivo .databrickscfg . Se você criar o perfil, substitua os espaços reservados pelos valores apropriados. Para utilizar o perfil com uma ferramenta ou SDK, consulte Tipos de autenticação suportados pela ferramenta Databricks ou SDK ou a documentação da ferramenta ou do SDK. Consulte também variável de ambiente e campos para autenticação unificada do cliente e a ordemdefault de avaliação para métodos e credenciais de autenticação unificada do cliente.

Defina os seguintes valores no arquivo .databrickscfg . Nesse caso, o host é a URL do espaço de trabalho do Databricks, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com:

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

Em vez de definir manualmente os valores anteriores no arquivo .databrickscfg , você pode usar a CLI do Databricks para definir esses valores, da seguinte maneira:

Observação

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

Para verificar se você já tem um perfil de configuração DEFAULT e para view as configurações desse perfil, se 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 comando databricks configure a seguir por um nome diferente para o perfil de configuração.

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

    databricks configure --profile DEFAULT
    
  2. Para o prompt Databricks Host, insira a URL da instância do espaço de trabalho do Databricks, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com.

  3. Para o prompt Personal access token, insira o access token pessoal do Databricks para seu workspace.

Para a CLI do Databricks, execute o comando databricks configure . Quando solicitado, insira as seguintes configurações:

  • O host do Databricks, especificado como a URL do espaço de trabalho do Databricks de destino, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com.

  • O token de acesso pessoal do Databricks, para a conta de usuário do Databricks ou principal do serviço do Databricks.

Para obter mais detalhes, consulte Autenticação access token pessoal do Databricks.

Observação

A autenticação access token pessoal do Databricks é suportada nas seguintes versões do Databricks Connect:

  • Para Python, Databricks Connect for Databricks Runtime 13.0 e acima.

  • Para Scala, Databricks Connect for Databricks Runtime 13.3 LTS e acima.

Para o Databricks Connect, você pode usar a CLI do Databricks para definir os valores em seu arquivo .databrickscfg, para operações no nível do workspacedo Databricks, conforme especificado na seção “Perfil” deste artigo, da seguinte maneira:

Observação

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

Para verificar se você já tem um perfil de configuração DEFAULT e para view as configurações desse perfil, se 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 comando databricks configure , conforme mostrado a seguir, por um nome diferente para o perfil de configuração.

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

    databricks configure --configure-cluster --profile DEFAULT
    
  2. Para o prompt Databricks Host, insira a URL da instância do espaço de trabalho do Databricks, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com.

  3. Para o prompt Personal access token, insira o access token pessoal do Databricks para seu workspace.

  4. Na lista de clusters disponíveis que aparece, use as key de seta para cima e para baixo para selecionar o cluster do Databricks de destino em seu workspace e pressione Enter. Você também pode digitar qualquer parte do nome de exibição do cluster para filtrar a lista de clusters disponíveis.

Outras abordagens suportadas para Databricks Connect incluem o seguinte:

  • Defina manualmente os valores em seu arquivo .databrickscfg para operações no nível workspacedo Databricks, conforme especificado na seção “Perfil” deste artigo. Configure também a variável de ambiente cluster_id em seu perfil para o URL da instância do espaço de trabalho, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com.

  • Defina a variável de ambiente para operações em nível de workspacedo Databricks conforme especificado na seção “Ambiente” deste artigo. Configure também a variável de ambiente DATABRICKS_CLUSTER_ID para o URL da instância do seu espaço de trabalho, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com.

Os valores no seu arquivo .databrickscfg sempre têm precedência sobre a variável de ambiente.

Para inicializar o cliente Databricks Connect com essas variáveis de ambiente ou valores em seu arquivo .databrickscfg , consulte um dos seguintes:

Para a extensão Databricks para Visual Studio Code, faça o seguinte:

  1. Defina os valores em seu arquivo .databrickscfg para operações no nível workspacedo Databricks conforme especificado na seção “Perfil” deste artigo.

  2. No painel Configuração da extensão Databricks para Visual Studio Code, clique em Configurar Databricks.

  3. No comando Palette, para Databricks Host, insira a URL do seu espaço de trabalho, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com e pressione Enter.

  4. Na paleta de comando, selecione o nome do seu perfil de destino na lista do seu URL.

Para obter mais detalhes, consulte Configuração de autenticação para a extensão Databricks para Visual Studio Code.

Para autenticaçãodefault :

provider "databricks" {
  alias = "workspace"
}

Para configuração direta (substitua os espaços reservados retrieve por sua própria implementação para recuperar os valores do console ou de algum outro armazenamento de configuração, como HashiCorp Vault. Consulte também Provedor do Vault). Nesse caso, o host é a URL do espaço de trabalho do Databricks, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com:

provider "databricks" {
  alias = "workspace"
  host  = <retrieve-workspace-url>
  token = <retrieve-token>
}

Para obter mais informações sobre a autenticação com o fornecedor Databricks Terraform, consulte Autenticação.

Para autenticaçãodefault :

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()
# ...

Para configuração direta (substitua os espaços reservados retrieve por sua própria implementação para recuperar os valores do console ou de algum outro armazenamento de configuração, como AWS Systems Manager Parameter Store). Nesse caso, o host é a URL do espaço de trabalho do Databricks, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com:

from databricks.sdk import WorkspaceClient

w = WorkspaceClient(
  host  = retrieve_workspace_url(),
  token = retrieve_token()
)
# ...

Para obter mais informações sobre a autenticação com ferramentas e SDKs do Databricks que usam Python e que implementam a autenticação unificada do cliente do Databricks, consulte:

Para autenticaçãodefault :

import com.databricks.sdk.WorkspaceClient;
// ...
WorkspaceClient w = new WorkspaceClient();
// ...

Para configuração direta (substitua os espaços reservados retrieve por sua própria implementação para recuperar os valores do console ou de algum outro armazenamento de configuração, como AWS Systems Manager Parameter Store). Nesse caso, o host é a URL do espaço de trabalho do Databricks, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com:

import com.databricks.sdk.WorkspaceClient;
import com.databricks.sdk.core.DatabricksConfig;
// ...
DatabricksConfig cfg = new DatabricksConfig()
  .setHost(retrieveWorkspaceUrl())
  .setToken(retrieveToken());
WorkspaceClient w = new WorkspaceClient(cfg);
// ...

Para obter mais informações sobre a autenticação com ferramentas e SDKs do Databricks que usam Java e que implementam a autenticação unificada do cliente do Databricks, consulte:

Para autenticaçãodefault :

import (
  "github.com/databricks/databricks-sdk-go"
)
// ...
w := databricks.Must(databricks.NewWorkspaceClient())
// ...

Para configuração direta (substitua os espaços reservados retrieve por sua própria implementação para recuperar os valores do console ou de algum outro armazenamento de configuração, como AWS Systems Manager Parameter Store). Nesse caso, o host é a URL do espaço de trabalho do Databricks, por exemplo https://dbc-a1b2345c-d6e7.cloud.databricks.com:

import (
  "github.com/databricks/databricks-sdk-go"
)
// ...
w := databricks.Must(databricks.NewWorkspaceClient(&databricks.Config{
  Host:  retrieveWorkspaceUrl(),
  Token: retrieveToken(),
}))
// ...

Para obter mais informações sobre a autenticação com ferramentas e SDKs do Databricks que usam Go e que implementam a autenticação unificada do cliente Databricks, consulte Autenticar o SDK do Databricks para Go com sua account ou workspacedo Databricks.