Configurar a autorização para a extensão do Databricks para Visual Studio Code

Este artigo descreve como configurar a autorização e a autenticação entre a extensão do Databricks para Visual Studio Code e seu workspace do Azure Databricks se você ainda não configurou a extensão por meio da instalação do projeto. Confira O que é a extensão do Databricks para Visual Studio Code?.

A extensão do Databricks para Visual Studio Code implementa partes da autenticação unificada do cliente Databricks padrão, o que permite configurar a autorização baseada no Azure Databricks OAuth 2.0 uma vez e, em seguida, usar essa configuração em várias ferramentas e SDKs do Azure Databricks sem mais alterações de configuração de autorização e autenticação. Ele também fornece atualizações automáticas de tokens de acesso ativos, reduzindo a complexidade do processo durante o desenvolvimento.

O Databricks recomenda a autorização de usuário interativa OAuth , que é fácil de configurar usando a extensão do Databricks para Visual Studio Code. Confira Configurar a autorização e autenticação do OAuth.

Caso contrário, se você estiver usando a Autenticação de token de acesso pessoal do Azure Databricks, Autorizar o acesso autônomo aos recursos do Azure Databricks com uma entidade de serviço usando o OAuth ou Autenticação de entidade de serviço do MS Entra, confira Configurar a autenticação com um perfil de configuração. Para a autenticação da CLI do Azure, confira Configurar a autenticação da CLI do Azure.

Observação

A extensão do Databricks para Visual Studio Code não oferece suporte à autenticação usando identidades gerenciadas do Azure (anteriormente conhecida como Identidades de Serviço Gerenciadas do Azure [MSI]), mas o Databricks Connect usado sem a extensão do Databricks para Visual Studio Code sim. Para instalar o Databricks Connect, confira Usar o Visual Studio Code com o Databricks Connect para Python.

configurar a autorização e a autenticação do OAuth

O Azure Databricks dá suporte à autorização e autenticação baseada em OAuth 2.0 e simplifica o gerenciamento de token de acesso com a autenticação de cliente unificada do Databricks. Para obter mais detalhes sobre a autorização de usuário e entidade de serviço com o Azure Databricks, confira Autorizar o acesso aos recursos do Azure Databricks.

Para concluir a instalação da autorização do OAuth, abra o projeto VSCode com a extensão do Databricks para Visual Studio Code habilitada:

1. No modo de exibição Configuração, clique em Tipo de autenticação e, em seguida, clique no ícone de engrenagem (Iniciar sessão no workspace do Databricks).

   

2. Se você já tiver um perfil de configuração de autenticação nesta lista que tenha o rótulo Autenticar usando o OAuth (Usuário para Computador) e que você sabe que corresponde ao host do Databricks de destino, selecione-o na lista e faça o seguinte:

   1. Se solicitado, conclua as instruções na tela no navegador da Web para concluir a autenticação com o Azure Databricks.
   2. Se solicitado, também permita o acesso all-apis.
   3. Pule para Selecionar um cluster para executar código e trabalhos.

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

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

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

6. No modo de exibição Configuração, clique em Fazer logon no Databricks.

   

7. Na Paleta de comandos, em Selecionar método de autenticação, selecione o nome do perfil de configuração de autenticação que você acabou de criar.

8. Se solicitado, conclua as instruções na tela no navegador da Web para concluir a autenticação com o Azure Databricks. Se solicitado, também permita o acesso all-apis.

9. Após fazer o logon, retorne ao Visual Studio Code.

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

As instruções a seguir pressupõem que você já configurou um perfil de configuração do Azure Databricks com os campos necessários para o tipo de autenticação do Azure Databricks. Para criar um perfil, confira Perfis de configuração do Azure Databricks. Para definir as configurações do perfil, confira a guia Perfil ou seção do tipo de autenticação em Autorizar acesso aos recursos do Azure Databricks.

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

1. No modo de exibição Configuração, clique em Tipo de autenticação e, em seguida, clique no ícone de engrenagem (Iniciar sessão no workspace do Databricks).

   

2. Na Paleta de comandos, selecione seu perfil de configuração do Azure Databricks de destino na lista.

   Dica

   O host do espaço de trabalho de destino pode ser alterado posteriormente modificando a configuração workspace de destino no arquivo de configuração databricks.yml associado ao projeto. Confira Configuração do Pacote de Ativos do Databricks.

Caso não tenha um perfil de configuração, poderá criar um que faça autenticação usando um token de acesso pessoal do Azure Databricks, por exemplo, da seguinte maneira:

1. Com o projeto e a extensão abertos, no modo de exibição Configuração, clique em Tipo de autenticação ou Fazer logon no Databricks e, em seguida, clique no ícone de engrenagem (Iniciar sessão no workspace do Databricks).

   

2. Na Paleta de comandos, selecione Token de acesso pessoal.

3. Conclua as solicitações na tela para fazer o seguinte:

   1. Insira um nome para o perfil de autenticação associado do Azure Databricks.
   2. Gere o token de acesso pessoal no seu workspace do Azure Databricks e copie o valor do token.
   3. Retorne à extensão e insira o valor copiado do token.

A extensão criará uma pasta em seu projeto chamada .databricks com um arquivo chamado databricks.env se ele ainda não existir. Esse arquivo contém o host do espaço de trabalho que você inseriu, juntamente com outros detalhes de configuração do Azure Databricks usados pela extensão do Databricks para Visual Studio Code.

A extensão também adicionará um arquivo oculto .gitignore 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.

Configurar a autenticação da CLI do Azure.

O Azure Databricks dá suporte à autenticação com a CLI do Azure instalada localmente. Isso permite que você gere tokens do Microsoft Entra ID de curta duração (uma hora), o que elimina o risco de expor acidentalmente tokens de vida mais longa, como tokens de acesso pessoal do Azure Databricks por meio de check-ins de controle de versão ou outros meios.

Com o projeto e a extensão abertas, e a CLI do Azure instalada localmente, faça o seguinte:

1. No modo de exibição Configuração, clique em Configurar o Databricks.

   Observação

   Se a opção Configurar o Databricks não estiver visível, clique no ícone de engrenagem (Configurar workspace) ao lado de Configuração.

   

2. Na Paleta de Comandos, para o Host do Databricks, insira a URL por workspace, por exemplo https://adb-1234567890123456.7.azuredatabricks.net. Em seguida, pressione Enter.

3. Selecione CLI do Azure.