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

Este artigo descreve como configurar a autorização e autenticação entre a extensão Databricks para Visual Studio Code e o seu espaço de trabalho Azure Databricks, caso ainda não tenha configurado a extensão através da configuração do projeto. Consulte a extensão Databricks para Visual Studio Code.

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

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

Caso contrário, se estiver a usar Autenticar com tokens de acesso pessoal (legado) do Azure Databricks, Autorizar o acesso do principal do serviço ao Azure Databricks com OAuth, ou Autenticar com principais de serviço do Microsoft Entra, consulte Configurar a autenticação com um perfil de configuração. Para Autenticar com a Azure CLI, veja Configurar Azure CLI autenticação.

Nota

A extensão Databricks para Visual Studio Code não suporta autenticação usando identidades geridas Azure (anteriormente Azure Managed Service Identities (MSI)), mas Databricks Connect usada sem a extensão Databricks para Visual Studio Code suporta. Para instalar o Databricks Connect, consulte Install Databricks Connect para Python.

Configurar a autorização e autenticação OAuth

Azure Databricks suporta autorização e autenticação baseadas em OAuth 2.0, e simplifica a gestão de tokens de acesso com autenticação unificada Databricks. Para mais detalhes sobre autorização do utilizador e do principal do serviço com Azure Databricks, consulte Autorizar acesso a recursos Azure Databricks.

Para completar a configuração da autorização OAuth, abra o seu projeto VSCode com a extensão Databricks para Visual Studio Code ativada:

  1. Na vista de Configuração, clique em Tipo de Autenticação e, em seguida, clique no ícone de engrenagem (Iniciar sessão na área de trabalho Databricks).

    Entrar no espaço de trabalho Databricks

  2. Se já tiver um perfil de configuração de autenticação nesta lista que tenha o rótulo Autenticar usando OAuth (User to Machine) e que saiba que corresponde ao host Databricks de destino, selecione-o na lista e proceda conforme abaixo:

    1. Se solicitado, complete quaisquer instruções no ecrã no seu navegador web para terminar a autenticação com o Azure Databricks.
    2. Se também solicitado, permita o acesso a todas as APIs .
    3. Pule para Selecionar recursos de computação para executar código e tarefas.
  3. Na Paleta de Comandos, para Selecionar método de autenticação, clique em OAuth (usuário para máquina).

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

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

  6. Na visualização Configuração, clique em Login no Databricks.

    Iniciar sessão no Databricks

  7. Na Paleta de Comandos, para Selecionar método de autenticação, selecione o nome do perfil de configuração de autenticação que acabou de criar.

  8. Se solicitado, complete quaisquer instruções no ecrã no seu navegador web para terminar a autenticação com o Azure Databricks. Se também solicitado, permita o acesso a todas as APIs .

  9. Depois de iniciar sessão com sucesso, volte ao Visual Studio Code.

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

As instruções seguintes assumem que já configurou um perfil de configuração do Azure Databricks com os campos necessários para o seu tipo de autenticação Azure Databricks. Para criar um perfil, consulte Azure Databricks perfis de configuração. Para configurar as definições do perfil, consulte o separador ou secção Profile para o seu tipo de autenticação em Autorizar acesso a Azure Databricks recursos.

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

  1. Na vista de Configuração, clique em Tipo de Autenticação e, em seguida, clique no ícone de engrenagem (Iniciar sessão na área de trabalho Databricks).

    Entrar no espaço de trabalho Databricks

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

    Gorjeta

    O host do espaço de trabalho de destino pode ser alterado posteriormente modificando a configuração de destino workspace no databricks.yml arquivo de configuração associado ao projeto. Veja as metas.

Se não tiver um perfil de configuração, pode criar um que autentique usando um token de acesso pessoal do Azure Databricks, por exemplo, da seguinte forma:

  1. Com o seu projeto e a extensão abertos, na visualização Configuração, clique em Auth Type ou Login no Databricks e, em seguida, clique no ícone de engrenagem (Entrar no espaço de trabalho do Databricks).

    Entrar no espaço de trabalho Databricks

  2. Na Paleta de Comandos, selecione Token de Acesso Pessoal.

  3. Complete os prompts no ecrã para fazer o seguinte:

    1. Insira algum nome para o perfil de autenticação Azure Databricks associado.
    2. Gera o token de acesso pessoal no teu espaço de trabalho do Azure Databricks e depois copia o valor do token.
    3. Retorne à extensão e insira o valor do token copiado.

A extensão cria uma pasta em seu projeto nomeada .databricks com um arquivo chamado databricks.env, se ele ainda não existir. Este ficheiro contém o host do workspace que introduziu, juntamente com outros detalhes de configuração do Azure Databricks usados pela extensão Databricks para Visual Studio Code.

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.

Configurar autenticação Azure CLI

Azure Databricks suporta autenticação com o Azure CLI instalado localmente. Isto permite-lhe gerar tokens Microsoft Entra ID de curta duração (uma hora), o que elimina o risco de expor acidentalmente tokens de maior duração, como os tokens de acesso pessoal do Azure Databricks, através de checkins de controlo de versões ou outros meios.

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

  1. Na visualização Configuração, clique em Configurar Databricks.

    Nota

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

    Ícone de engrenagem para definir as configurações do espaço de trabalho 1

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

  3. Selecione Azure CLI.