Configuração de autenticação para a extensão Databricks para VS Code

Este artigo descreve como configurar a autenticação entre a extensão Databricks para Visual Studio Code e seu espaço de trabalho Azure Databricks. Consulte O que é a extensão Databricks para Visual Studio Code?

A extensão Databricks para Visual Studio Code implementa partes do padrão de autenticação unificada do cliente Databricks, uma abordagem arquitetônica e programática consolidada e consistente para autenticação. Essa abordagem ajuda a tornar a configuração e a automação da autenticação com o Azure Databricks mais centralizadas e previsíveis. Ele permite que você configure a autenticação do Azure Databricks uma vez e, em seguida, use essa configuração em várias ferramentas e SDKs do Azure Databricks sem alterações adicionais na configuração de autenticação.

As informações a seguir pressupõem que você já tenha instalado a extensão Databricks para Visual Studio Code. Consulte Instalar a extensão Databricks para Visual Studio Code.

Nota

Se você já concluiu o tutorial da extensão VSCode para Databricks: Executar Python em um cluster e como um trabalho e deseja continuar usando a autenticação de token de acesso pessoal do Azure Databricks que você configurou nesse tutorial, pule para Selecionar um cluster para a extensão Databricks para Visual Studio Code.

Dependendo do tipo de autenticação que você deseja usar, conclua as instruções para seu tipo de autenticação de destino do Azure Databricks.

• Para os seguintes tipos de autenticação, avance para Configurar a autenticação com um perfil de configuração:
  • Autenticação do token de acesso pessoal do Azure Databricks
  • Autenticação máquina a máquina (M2M) OAuth
  • Autenticação ddo principal de serviço do Microsoft Entra ID
• Para autenticação OAuth user-to-machine (U2M), pule para Configurar a autenticação OAuth U2M.
• Para autenticação da CLI do Azure, pule para Configurar a autenticação da CLI do Azure.

Nota

A extensão Databricks para Visual Studio Code ainda não oferece suporte à autenticação usando identidades gerenciadas do Azure (anteriormente Azure Managed Service Identities (MSI)).

O Databricks Connect dá suporte à autenticação usando identidades gerenciadas do Azure. No entanto, você não pode usar a integração do Databricks Connect dentro da extensão Databricks para Visual Studio Code para fazer a autenticação de identidade gerenciada do Azure. Para usar o Databricks Connect com o Visual Studio Code por si só, separado da extensão Databricks para Visual Studio Code, consulte Usar o Visual Studio Code com Databricks Connect for Python.

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

As instruções a seguir pressupõem que você já tenha configurado um perfil de configuração do Azure Databricks com os campos necessários para seu tipo de autenticação do Azure Databricks. Consulte Perfis de configuração do Azure Databricks e a guia ou seção Perfil para seu tipo de autenticação em Autenticação para automação do Azure Databricks - visão geral.

Por exemplo, se você quiser autenticar usando a autenticação de token de acesso pessoal do Azure Databricks, crie seu token de acesso pessoal fazendo o seguinte:

1. No seu espaço de trabalho do Azure Databricks, clique no seu nome de utilizador do Azure Databricks na barra superior e, em seguida, selecione Definições na lista pendente.
2. Clique em Desenvolvedor.
3. Ao lado de Tokens de acesso, clique em Gerenciar.
4. Clique em Gerar novo token.
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 tempo de vida (não recomendado), deixe a caixa Tempo de vida (dias) vazia (em branco).
6. Clique em Generate (Gerar).
7. Copie o token exibido para um local seguro e clique em Concluído.

Nota

Certifique-se de salvar o token copiado em um local seguro. Não partilhe o seu token copiado com outras pessoas. Se você perder o token copiado, não poderá regenerar exatamente o mesmo token. Em vez disso, você deve repetir esse procedimento para criar um novo token. Se você perder o token copiado ou acreditar que o token foi comprometido, o Databricks recomenda que você exclua imediatamente esse token do seu espaço de trabalho clicando no ícone da lixeira (Revogar) ao lado do token na página de tokens do Access.

Se você não conseguir criar ou usar tokens em seu espaço de trabalho, isso pode ser porque o administrador do espaço de trabalho desabilitou tokens ou não lhe deu permissão para criar ou usar tokens. Consulte o administrador do espaço de trabalho ou o seguinte:

• Habilitar ou desabilitar a autenticação de token de acesso pessoal para o espaço de trabalho
• Permissões de token de acesso pessoal

E, por exemplo, para criar um perfil de configuração nomeado DEFAULT para seu token de acesso pessoal, faça o seguinte:

Nota

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 DEFAULT configuração, este procedimento substituirá o perfil de configuração existente DEFAULT .

Para verificar se você já tem um perfil de DEFAULT configuração e para 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 DEFAULTde , substitua a DEFAULT parte do comando a seguir databricks configure por um nome diferente para o perfil de --profile DEFAULT configuração.

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

   databricks configure --profile DEFAULT
   

2. Para o prompt Databricks Host, insira sua URL do Azure Databricks por espaço de trabalho, por exemplohttps://adb-1234567890123456.7.azuredatabricks.net.

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

Depois de ter seu perfil de configuração do Azure Databricks pronto, com seu projeto e a extensão abertos, faça o seguinte:

1. No painel Configuração, clique em Configurar Databricks.

   Nota

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

   

2. Na Paleta de comandos, para Databricks Host, insira sua URL por espaço de trabalho, por exemplo https://adb-1234567890123456.7.azuredatabricks.net. Em seguida, prima Enter.

3. Selecione seu perfil de configuração do Azure Databricks de destino na lista da URL.

A extensão cria uma pasta oculta em seu projeto com o nome .databricks se ela ainda não existir. A extensão também cria nesta pasta um arquivo chamado project.json se ele ainda não existe. Esse arquivo contém a URL que você inseriu, juntamente com alguns detalhes de autenticação do Azure Databricks que a extensão Databricks para Visual Studio Code precisa operar.

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

Continue com Selecione um cluster para a extensão Databricks para Visual Studio Code.

Configurar a autenticação U2M do OAuth

O Azure Databricks dá suporte à autenticação OAuth de usuário para máquina (U2M). Isso permite gerar tokens de acesso OAuth 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 checkins de controle de versão ou outros meios. Isso também permite uma melhor invalidação e escopo da sessão do lado do servidor.

Para concluir a configuração para autenticação OAuth U2M, com seu projeto e a extensão aberta, faça o seguinte:

1. No painel Configuração, clique em Configurar Databricks.

   Nota

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

   

2. Na Paleta de comandos, para Databricks Host, insira sua URL por espaço de trabalho, por exemplo https://adb-1234567890123456.7.azuredatabricks.net. Em seguida, prima Enter.

3. Selecione OAuth (usuário para máquina).

4. Conclua as instruções na tela em seu navegador da Web para concluir a autenticação com sua conta do Azure Databricks. Se solicitado, permita o acesso a todas as APIs .

A extensão cria uma pasta oculta em seu projeto com o nome .databricks se ela ainda não existir. A extensão também cria nesta pasta um arquivo chamado project.json se ele ainda não existe. Esse arquivo contém a URL que você inseriu, juntamente com alguns detalhes de autenticação do Azure Databricks que a extensão Databricks para Visual Studio Code precisa operar.

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

Continue com Selecione um cluster para a extensão Databricks para Visual Studio Code.

Configurar a autenticação da CLI do Azure

O Azure Databricks dá suporte à autenticação com a CLI do Azure instalada localmente. Isso permite gerar tokens Microsoft Entra ID (anteriormente Azure Ative Directory) 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 checkins de controle de versão ou outros meios.

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

1. No painel Configuração, clique em Configurar Databricks.

   Nota

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

   

2. Na Paleta de comandos, para Databricks Host, insira sua URL por espaço de trabalho, por exemplo https://adb-1234567890123456.7.azuredatabricks.net. Em seguida, prima Enter.

3. Selecione CLI do Azure.

A extensão cria uma pasta oculta em seu projeto com o nome .databricks se ela ainda não existir. A extensão também cria nesta pasta um arquivo chamado project.json se ele ainda não existe. Esse arquivo contém a URL que você inseriu, juntamente com alguns detalhes de autenticação do Azure Databricks que a extensão Databricks para Visual Studio Code precisa operar.

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

Continue com Selecione um cluster para a extensão Databricks para Visual Studio Code.