Configuração de autenticação para a extensão Databricks para Visual Studio Code

Este artigo descreve como configurar a autenticação entre a extensão Databricks para Visual Studio Code e seu Databricks workspace se o senhor ainda não tiver configurado a extensão por meio da configuração do projeto. Consulte O que é a extensão Databricks para o Visual Studio Code?

A extensão do Databricks para o Visual Studio Code implementa partes do padrão de autenticação unificada do cliente Databricks, o que permite que o senhor configure a autenticação do Databricks uma vez e, em seguida, use essa configuração em várias ferramentas e SDKs do Databricks sem outras alterações na configuração da autenticação.

A Databricks recomenda a autenticação OAuth U2M, que é fácil de configurar usando a extensão da Databricks para o Visual Studio Code. Consulte Configurar a autenticação OAuth U2M.

Caso contrário, se o senhor estiver usando a autenticaçãoDatabricks pessoal access token ou Autenticar o acesso a Databricks com uma entidade de serviço usando OAuth (OAuth M2M), consulte Configurar a autenticação com um perfil de configuração.

Observação

A autenticação básica usando um nome de usuário e senha da Databricks chegou ao fim da vida útil em 10 de julho de 2024. Consulte End of life para Databricks-gerenciar senhas.

Configurar a autenticação OAuth U2M

O Databricks é compatível com a autenticação OAuth de usuário para máquina (U2M). Isso permite que o senhor gere um token de acesso OAuth de curta duração (uma hora), o que elimina o risco de expor acidentalmente tokens de vida mais longa, como o token de acesso pessoal da Databricks, por meio de check-ins de controle de versão ou outros meios. Isso também permite uma melhor invalidação e delimitação de escopo da sessão no lado do servidor.

Para concluir a configuração da autenticação OAuth U2M, com seu projeto e a extensão abertos:

  1. Em Configuration view, clique em Auth Type e, em seguida, clique no ícone de engrenagem(Sign in to Databricks workspace ).

    Faça login na Databricks workspace
  2. Se o senhor já tiver um perfil de configuração de autenticação nessa lista que tenha o rótulo Authenticate using OAuth (User to Machine) e que saiba que corresponde ao host de destino do Databricks, selecione-o na lista e faça o seguinte:

    1. Se solicitado, conclua todas as instruções na tela do navegador da Web para concluir a autenticação na Databricks.

    2. Se também for solicitado, permita o acesso a todos os aplicativos.

    3. Avance para Select a cluster para executar o código e o Job.

  3. Na paleta de comandos, para Selecionar método de autenticação, clique em OAuth (usuário para máquina).

  4. Em Select authentication method (Selecionar método de autenticação), selecione OAuth (usuário para máquina).

  5. Digite um nome para o perfil de autenticação associado do Databricks.

  6. Em Configuration view, clique em Login to Databricks.

    Faça login na Databricks
  7. Na paleta de comandos, em Select authentication method (Selecionar método de autenticação), selecione o nome do perfil de configuração de autenticação que o senhor acabou de criar.

  8. Se solicitado, conclua todas as instruções na tela do navegador da Web para concluir a autenticação na Databricks. Se também for solicitado, permita o acesso a todos os aplicativos.

  9. Depois de fazer o login com sucesso, retorne ao Visual Studio Code.

Configurar a autenticação com um perfil de configuração

As instruções a seguir pressupõem que o senhor já tenha definido um perfil de configuração do Databricks com os campos necessários para o tipo de autenticação do Databricks. Para criar um perfil, consulte Perfis de configuração do Databricks. Para definir as configurações do perfil, consulte o Profile tab ou a seção do seu tipo de autenticação em Authenticate access to Databricks recurso.

Para selecionar o perfil de configuração que o senhor deseja que a extensão use, com o projeto e a extensão abertos, faça o seguinte

  1. Em Configuration view, clique em Auth Type e, em seguida, clique no ícone de engrenagem(Sign in to Databricks workspace ).

    Faça login na Databricks workspace
  2. Na paleta de comandos, selecione o perfil de configuração de destino do Databricks na lista.

    Dica

    O host de destino workspace pode ser alterado posteriormente, modificando a configuração de destino workspace no arquivo de configuração databricks.yml associado ao projeto. Consulte Databricks ativo Bundle configuration.

Se o senhor não tiver um perfil de configuração, poderá criar um que autentique usando um Databricks pessoal access token, por exemplo, da seguinte forma:

  1. Com seu projeto e a extensão abertos, em Configuration view, clique em Auth Type ou Login to Databricks e, em seguida, clique no ícone de engrenagem(Sign in to Databricks workspace ).

    Faça login na Databricks workspace
  2. Na paleta de comandos, selecione Personal access token.

  3. Preencha os prompts na tela para fazer o seguinte:

    1. Digite um nome para o perfil de autenticação associado do Databricks.

    2. Gere o access token pessoal em seu Databricks workspace e, em seguida, copie o valor dos tokens.

    3. Retorne à extensão e insira o valor dos tokens copiados.

A extensão cria uma pasta em seu projeto chamada .databricks com um arquivo chamado databricks.env, caso ele ainda não exista. Esse arquivo contém o host workspace que o senhor inseriu, juntamente com outros detalhes de configuração do Databricks usados pela extensão Databricks para o Visual Studio Code.

A extensão também adiciona um arquivo .gitignore oculto ao projeto se o arquivo não existir ou se um .gitignore existente não puder ser encontrado em nenhuma pasta pai. Se um novo arquivo .gitignore for criado, a extensão adicionará uma entrada .databricks/ a esse novo arquivo. Se a extensão encontrar um arquivo .gitignore existente, ela adicionará uma entrada .databricks/ ao arquivo existente.