Autenticação para automação do Azure Databricks – visão geral

  • Artigo

No Azure Databricks, autenticação refere-se à verificação de uma identidade do Azure Databricks (como um usuário, entidade de serviço ou grupo) ou uma identidade gerenciada do Azure. O Azure Databricks usa credenciais (como um token de acesso) para verificar a identidade.

Depois que o Azure Databricks verifica a identidade do chamador, o Azure Databricks usa um processo chamado autorização para determinar se a identidade verificada tem permissões de acesso suficiente para executar a ação especificada no recurso no local especificado. Este artigo inclui detalhes apenas sobre autenticação. Elas não incluem detalhes sobre permissões de acesso ou autorização. Confira Autenticação e controle de acesso.

Quando uma ferramenta faz uma solicitação de automação ou de API, ela inclui credenciais que autenticam uma identidade com o Azure Databricks. Este artigo descreve maneiras típicas de criar, armazenar e passar credenciais e informações relacionadas que o Azure Databricks precisa para autenticar e autorizar solicitações. Para saber quais tipos de credenciais, informações relacionadas e mecanismo de armazenamento são suportados por suas ferramentas, SDKs, scripts e aplicativos, consulte Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks ou a documentação do seu provedor.

Tarefas comuns para autenticação do Azure Databricks

Use as instruções a seguir para concluir tarefas comuns para autenticação do Azure Databricks.

Para concluir esta tarefa... Siga as instruções neste artigo
Crie um usuário do Azure Databricks que você possa usar para autenticação no nível da conta do Azure Databricks. Gerencie usuários em sua conta
Crie um usuário do Azure Databricks que você pode usar para autenticação com um espaço de trabalho específico do Azure Databricks. Gerencie usuários em seu espaço de trabalho
Crie um token de acesso pessoal do Azure Databricks para um usuário do Azure Databricks. (Este token de acesso pessoal do Azure Databricks pode ser usado apenas para autenticação com seu espaço de trabalho associado do Azure Databricks.) Tokens de acesso pessoal do Azure Databricks para usuários do espaço de trabalho
Crie uma entidade de serviço gerenciada do Azure Databricks e adicione essa entidade de serviço gerenciada do Azure Databricks a uma conta do Azure Databricks, um workspace específico do Azure Databricks ou ambos. Em seguida, você pode usar essa entidade de serviço para autenticação no nível da conta do Azure Databricks, com um workspace específico do Azure Databricks ou ambos. Gerenciar entidades de serviço
Crie um perfil de configuração do Azure Databricks. Perfis de configuração do Azure Databricks
Crie um grupo do Azure Databricks e adicione usuários do Azure Databricks e entidades de serviço do Azure a esse grupo, para obter uma autorização mais robusta. Gerenciar grupos de contas usando o console de contasGerenciar grupos de contas usando a página de configurações de administrador do espaço de trabalho

Tipos de autenticação do Azure Databricks com suporte

O Azure Databricks fornece várias maneiras de autenticar usuários do Azure Databricks, entidades de serviço e identidades gerenciadas do Azure, da seguinte maneira:

Tipo de autenticação Detalhes
Autenticação de identidades gerenciadas do Azure * A autenticação de identidades gerenciadas do Azure usa identidades gerenciadas para recursos do Azure para autenticação. Consulte O que são identidades gerenciadas para recursos do Azure?.
* As identidades gerenciadas do Azure usam tokens do Microsoft Entra ID para credenciais de autenticação. Esses tokens são gerenciados internamente nos sistemas da Microsoft. Você não pode acessar esses tokens.
* A autenticação de identidades gerenciadas do Azure deve ser iniciada a partir de um recurso que dá suporte para identidades gerenciadas do Azure, como uma máquina virtual do Azure (VM do Azure).
* Para obter detalhes técnicos adicionais, confira Autenticação de identidades gerenciadas do Azure.
Autenticação M2M (de computador para computador) do OAuth * A autenticação OAuth M2M usa entidades de serviço para autenticação. Ela pode ser usada com entidades de serviço gerenciadas do Azure Databricks ou entidades de serviço gerenciadas do Microsoft Entra ID.
* A autenticação OAuth M2M usa tokens de acesso OAuth do Azure Databricks de curta duração (uma hora) para credenciais de autenticação.
* Os tokens de acesso expirados do OAuth do Azure Databricks podem ser atualizados automaticamente pelas ferramentas e SDKs participantes do Azure Databricks. Consulte Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks e Autenticação unificada do cliente Databricks.
* O Databricks recomenda que você use a autenticação OAuth M2M para cenários de autenticação autônomos. Esses cenários incluem fluxos de trabalho de CI/CD e totalmente automatizados, em que você não pode usar seu navegador da Web para autenticar com o Azure Databricks em tempo real.
* A Databricks recomenda que você use Autenticação de identidades gerenciadas do Azure, se sua ferramenta ou SDK do Azure Databricks de destino oferecer suporte, em vez da autenticação OAuth M2M. Isso ocorre porque a autenticação de identidades gerenciadas do Azure não expõe credenciais.
* A Databricks recomenda que você use autenticação principal do serviço Microsoft Entra ID, em vez da autenticação OAuth M2M, nos casos em que você deve usar tokens Microsoft Entra ID para credenciais de autenticação. Por exemplo, poderá ser necessário autenticar-se com Azure Databricks e outros recursos do Azure ao mesmo tempo, o que requer tokens de ID Microsoft Entra.
* Para obter detalhes técnicos adicionais, consulte Autenticação OAuth M2M (máquina para máquina) .
Autenticação U2M (usuário para computador) do OAuth * A autenticação OAuth U2M usa usuários do Azure Databricks para autenticação.
* A autenticação OAuth U2M usa tokens de acesso OAuth do Azure Databricks de curta duração (uma hora) para credenciais de autenticação.
* As ferramentas e SDKs participantes do Azure Databricks podem atualizar automaticamente tokens de acesso OAuth expirados. Consulte Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks e Autenticação unificada do cliente Databricks.
* A autenticação OAuth U2M é adequada para cenários de autenticação assistida. Esses cenários incluem fluxos de trabalho de desenvolvimento manuais e rápidos, onde utiliza o seu navegador web para autenticar com Azure Databricks em tempo real, quando solicitado.
* A Databricks recomenda que você use Autenticação de identidades gerenciadas do Azure, se sua ferramenta ou SDK do Azure Databricks de destino oferecer suporte, em vez da autenticação OAuth U2M. Isso ocorre porque a autenticação de identidades gerenciadas do Azure não expõe credenciais.
* Para detalhes técnicos adicionais, consulte Autenticação de usuário para máquina (U2M) do OAuth.
Autenticação da entidade de serviço do Microsoft Entra ID * A autenticação da entidade de serviço do Microsoft Entra ID usa entidades de serviço do Microsoft Entra ID para autenticação. Ela não pode ser usada com a entidade de serviço gerenciado do Azure Databricks.
* A autenticação da entidade de serviço do Microsoft Entra ID usa tokens do Microsoft Entra ID de curta duração (geralmente uma hora) para credenciais de autenticação.
* Os tokens vencidos do Microsoft Entra ID podem ser atualizados automaticamente pelas ferramentas e pelos SDKs participantes do Azure Databricks. Consulte Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks e Autenticação unificada do cliente Databricks.
* A Databricks recomenda que você use Autenticação de identidades gerenciadas do Azure, se sua ferramenta ou SDK do Azure Databricks de destino oferecer suporte, em vez da autenticação principal do serviço Microsoft Entra ID. Isso ocorre porque a autenticação de identidades gerenciadas do Azure não expõe credenciais.
* Se não puder utilizar a autenticação de identidades geridas pelo Azure, a Databricks recomenda que utilize autenticação OAuth M2M em vez da autenticação principal do serviço Microsoft Entra ID.
* A Databricks recomenda que você use a autenticação principal do serviço Microsoft Entra ID nos casos em que você deve usar tokens Microsoft Entra ID para credenciais de autenticação. Por exemplo, poderá ser necessário autenticar-se com Azure Databricks e outros recursos do Azure ao mesmo tempo, o que requer tokens de ID Microsoft Entra.
* Para detalhes técnicos adicionais, consulte Autenticação da entidade de serviço do Microsoft Entra ID.
Autenticação da CLI do Azure * A autenticação da CLI do Azure utiliza a CLI do Azure juntamente com utilizadores do Azure Databricks ou entidades de serviço geridas pelo Microsoft Entra ID para autenticação.
* A autenticação da CLI do Azure usa tokens do Microsoft Entra ID de curta duração (geralmente uma hora) para credenciais de autenticação.
* As ferramentas e SDKs participantes do Azure Databricks podem atualizar automaticamente os tokens expirados do Microsoft Entra ID. SDKs. Consulte Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks e Autenticação unificada do cliente Databricks.
* A Databricks recomenda Autenticação de identidades gerenciadas do Azure, se sua ferramenta ou SDK do Azure Databricks de destino oferecer suporte, em vez da autenticação CLI do Azure. A autenticação de identidades geridas pelo Azure utiliza identidades geridas pelo Azure em vez de utilizadores do Azure Databricks ou entidades de serviço geridas pelo Microsoft Entra ID, e as identidades geridas pelo Azure são mais seguras do que os utilizadores do Azure Databricks ou entidades de serviço geridas pelo Microsoft Entra ID, uma vez que a autenticação de identidades geridas pelo Azure não expõe credenciais. Consulte O que são identidades gerenciadas para recursos do Azure?.
* A Databricks recomenda que utilize a autenticação CLI do Azure nos casos em que deve utilizar tokens Microsoft Entra ID para credenciais de autenticação. Por exemplo, poderá ser necessário autenticar-se com Azure Databricks e outros recursos do Azure ao mesmo tempo, o que requer tokens de ID Microsoft Entra.
* A autenticação da CLI do Azure é adequada para cenários de autenticação supervisionados. Esses cenários incluem fluxos de trabalho de desenvolvimento manuais e rápidos, em que você usa a CLI do Azure para autenticar com o Azure Databricks em tempo real.
* Para detalhes técnicos adicionais, consulte Autenticação da CLI do Azure.
Autenticação de token de acesso pessoal do Azure Databricks * A autenticação de token de acesso pessoal do Azure Databricks usa usuários do Azure Databricks para autenticação.
* A autenticação de token de acesso pessoal do Azure Databricks usa cadeias de caracteres de curta ou longa duração para credenciais de autenticação. Esses tokens de acesso podem ser definidos para expirar em um dia ou menos, ou podem ser configurados para nunca expirar.
* Os tokens de acesso pessoal do Azure Databricks expirados não podem ser atualizados.
* O Databricks não recomenda tokens de acesso pessoal do Azure Databricks (especialmente tokens de acesso de longa duração) para credenciais de autenticação, pois eles são menos seguros do que os tokens de acesso Microsoft Entra ID ou OAuth do Azure Databricks.
* A Databricks recomenda Autenticação de identidades gerenciadas do Azure, se o Azure Databrickstool ou SDK de destino oferecer suporte, em vez da autenticação de token de acesso pessoal do Azure Databricks. A autenticação de identidades gerenciadas do Azure utiliza identidades gerenciadas do Azure em vez de usuários do Azure Databricks, e as identidades gerenciadas do Azure são mais seguras do que os usuários do Azure Databricks. Consulte O que são identidades gerenciadas para recursos do Azure?.
* Se não puder utilizar a autenticação de identidades geridas pelo Azure, a Databricks recomenda que utilize autenticação CLI do Azure em vez da autenticação de token de acesso pessoal do Azure Databricks.
* Para detalhes técnicos adicionais, consulte Autenticação de token de acesso pessoal do Azure Databricks.

Tipos de autenticação com suporte pela ferramenta Azure Databricks ou SDK

As ferramentas e SDKs do Azure Databricks que funcionam com um ou mais tipos de autenticação do Azure Databricks com suporte incluem o seguinte:

Ferramenta ou SDK Tipos de autenticação com suporte
CLI do Databricks * Autenticação OAuth máquina a máquina (M2M)
* Autenticação U2M (usuário para computador) do OAuth
* Autenticação de identidades gerenciadas do Azure
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure
* Autenticação de token de acesso pessoal do Azure Databricks

Para obter a documentação específica da autenticação da CLI do Databricks, incluindo como configurar e usar osperfis de configuração do Azure Databricks, para alternar entre várias configurações de autenticação relacionadas, consulte:

* Autenticação OAuth máquina a máquina (M2M)
* Autenticação de identidades gerenciadas do Azure
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure
* Autenticação de token de acesso pessoal do Azure Databricks

Para detalhes técnicos adicionais sobre a CLI do Databricks, consulte O que é a CLI do Databricks? .
Provedor Terraform do Databricks * Autenticação OAuth máquina a máquina (M2M)
* Autenticação de identidades gerenciadas do Azure
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure
* Autenticação de token de acesso pessoal do Azure Databricks

A autenticação usuário-máquina (U2M) OAuth ainda não é compatível.

Para obter a documentação de autenticação de provedor do Databricks Terraform específica, incluindo como armazenar e usar credenciais por meio de variáveis de ambiente, perfis de configuração, arquivos .tfvars ou repositórios secretos do Azure Databricks, como Hashicorp Vault ou Azure Key Vault, consulte Autenticação.

Para detalhes técnicos adicionais sobre o provedor Databricks Terraform, consulte Provedor Databricks Terraform.
Databricks Connect * Autenticação OAuth máquina a máquina (M2M)
* Autenticação U2M (usuário para computador) do OAuth
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure
* Autenticação de token de acesso pessoal do Azure Databricks

A autenticação de identidades gerenciadas do Azure ainda não é compatível.

Para documentação de autenticação específica do Databricks Connect, consulte:

* Configure o cliente para Python
* Configure o cliente para o Scala

Para detalhes técnicos adicionais sobre o Databricks Connect, consulte O que é o Databricks Connect?.
Extensão do Databricks para Visual Studio Code * Autenticação OAuth máquina a máquina (M2M)
* Autenticação U2M (usuário para computador) do OAuth
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure
* Autenticação de token de acesso pessoal do Azure Databricks

A autenticação de identidades gerenciadas do Azure ainda não é compatível.

Para a extensão Databricks específica para documentação de autenticação de código do Visual Studio, consulte Configuração de autenticação para a extensão Databricks para o Visual Studio Code.

Para detalhes técnicos adicionais sobre a extensão Databricks para Visual Studio Code, consulte O que é a extensão Databricks para Visual Studio Code?.
SDK do Databricks para Python * Autenticação OAuth máquina a máquina (M2M)
* Autenticação U2M (usuário para computador) do OAuth
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure
* Autenticação de token de acesso pessoal do Azure Databricks

A autenticação de identidades gerenciadas do Azure ainda não é compatível.

Para documentação específica do SDK do Databricks para autenticação Python, consulte:

* Autentique o SDK do Databricks para Python com sua conta ou espaço de trabalho do Azure Databricks
* Autenticação

Para detalhes técnicos adicionais sobre o SDK do Databricks para Python, consulte SDK do Databricks para Python.
SDK do Databricks para Java * Autenticação OAuth máquina a máquina (M2M)
* Autenticação U2M (usuário para computador) do OAuth
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure
* Autenticação de token de acesso pessoal do Azure Databricks

A autenticação de identidades gerenciadas do Azure ainda não é compatível.

Para a documentação específica do SDK do Databricks para autenticação Java, consulte:

* Autentique o SDK do Databricks para Java com sua conta ou espaço de trabalho do Azure Databricks
* Autenticação

Para detalhes técnicos adicionais sobre o SDK do Databricks para Java, consulte SDK do Databricks para Java.
SDK do Databricks para Go * Autenticação OAuth máquina a máquina (M2M)
* Autenticação U2M (usuário para computador) do OAuth
* Autenticação de identidades gerenciadas do Azure
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure
* Autenticação de token de acesso pessoal do Azure Databricks

Para a documentação específica do SDK do Databricks para autenticação Java, consulte:

* Autentique o SDK do Databricks for Go com sua conta ou espaço de trabalho do Azure Databricks
* Autenticação

Para detalhes técnicos adicionais sobre o SDK do Databricks para Go, consulte SDK do Databricks para Go.
Pacotes de Ativos do Databricks * Autenticação OAuth máquina a máquina (M2M)
* Autenticação U2M (usuário para computador) do OAuth
* Autenticação de identidades gerenciadas do Azure
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação de token de acesso pessoal do Azure Databricks

Ainda não há suporte para a autenticação da CLI do Azure.

Para detalhes técnicos adicionais sobre os Pacotes de Ativos do Databricks, consulte O que são os Pacotes de Ativos do Databricks?.
Databricks Driver para SQLTools para o Visual Studio Code * Autenticação OAuth máquina a máquina (M2M)
* Autenticação U2M (usuário para computador) do OAuth
* Autenticação de token de acesso pessoal do Azure Databricks

Os seguintes tipos de autenticação ainda não são compatíveis:

* Autenticação de identidades gerenciadas do Azure
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure

Para detalhes técnicos adicionais sobre o Driver do Databricks para SQLTools para Visual Studio Code, consulte Driver do Databricks para SQLTools para Visual Studio Code.
Conector do Databricks SQL para Python * Autenticação OAuth máquina a máquina (M2M)
* Autenticação U2M (usuário para computador) do OAuth
* Autenticação de token de acesso pessoal do Azure Databricks

Os seguintes tipos de autenticação ainda não são compatíveis:

* Autenticação de identidades gerenciadas do Azure
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure

Para detalhes técnicos adicionais sobre o Conector SQL do Databricks para Python, consulte Conector SQL do Databricks para Python.
Driver do Databricks SQL para Node.js * Autenticação OAuth máquina a máquina (M2M)
* Autenticação U2M (usuário para computador) do OAuth
* Autenticação de token de acesso pessoal do Azure Databricks

Os seguintes tipos de autenticação ainda não são compatíveis:

* Autenticação de identidades gerenciadas do Azure
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure

Para detalhes técnicos adicionais sobre o Driver SQL do Databricks para Node.js, consulte Driver SQL do Databricks para Node.js.
Driver do Databricks SQL para Go * Autenticação OAuth máquina a máquina (M2M)
* Autenticação U2M (usuário para computador) do OAuth
* Autenticação de token de acesso pessoal do Azure Databricks

Os seguintes tipos de autenticação ainda não são compatíveis:

* Autenticação de identidades gerenciadas do Azure
* Autenticação de entidades de serviço do Microsoft Entra ID
* Autenticação da CLI do Azure

Para detalhes técnicos adicionais sobre o Driver SQL do Databricks para Go, consulte Driver SQL do Databricks para Go.
Outras ferramentas e SDKs do Azure Databricks Consulte a documentação da ferramenta ou SDK:

* SDK do Databricks para R
* CLI do Databricks SQL

APIs REST de conta e espaço de trabalho do Azure Databricks

O Databricks organiza a API REST do Databricks em duas categorias de APIs: APIs de conta e APIs de workspace. Cada uma dessas categorias requer diferentes conjuntos de informações para autenticar a identidade do Azure Databricks de destino. Além disso, cada tipo de autenticação do Databricks com suporte requer informações adicionais que identificam exclusivamente a identidade do Azure Databricks de destino.

Por exemplo, para autenticar uma identidade do Azure Databricks para chamar operações de API em nível de conta do Azure Databricks, você deve fornecer:

  • A URL do console da conta de destino do Azure Databricks, que normalmente é https://accounts.azuredatabricks.net.
  • A ID da conta de destino do Azure Databricks. Confira Localizar a ID da conta.
  • Informações que identificam com exclusividade a identidade do Azure Databricks de destino para o tipo de autenticação do Databricks de destino. Para obter as informações específicas a serem fornecidas, confira a seção mais adiante neste artigo para esse tipo de autenticação.

Para autenticar uma identidade do Azure Databricks para chamar as operações da API no nível do workspace do Azure Databricks, você deve fornecer:

  • A URL por workspace do Azure Databricks de destino, por exemplo https://adb-1234567890123456.7.azuredatabricks.net.
  • Informações que identificam com exclusividade a identidade do Azure Databricks de destino para o tipo de autenticação do Databricks de destino. Para obter as informações específicas a serem fornecidas, confira a seção mais adiante neste artigo para esse tipo de autenticação.

Autenticação unificada do cliente do Databricks

O Databricks oferece uma abordagem arquitetônica e programática consolidada e consistente para a autenticação, conhecida como autenticação unificada do cliente do Databricks. Essa abordagem ajuda a tornar a configuração e a automação da autenticação com o Databricks mais centralizada e previsível. Ele permite que você configure a autenticação do Databricks uma vez e use essa configuração em várias ferramentas e SDKs do Databricks sem mais alterações na configuração da autenticação.

As ferramentas e os SDKs do Databricks participantes incluem:

Todas as ferramentas e SDKs participantes aceitam variáveis de ambiente especiais e perfis de configuração do Azure Databricks para autenticação. O provedor Terraform do Databricks e os SDKs do Databricks para Python, Java e Go também aceitam a configuração direta das definições de autenticação no código. Para obter detalhes, confira Tipos de autenticação com suporte pelo SDK ou ferramenta do Azure Databricks ou a documentação da ferramenta ou do SDK.

Ordem padrão de avaliação para credenciais e métodos de autenticação unificada do cliente

Sempre que uma ferramenta ou o SDK participante precisar se autenticar com o Azure Databricks, a ferramenta ou o SDK tentará os seguintes tipos de autenticação na ordem a seguir por padrão. Quando a ferramenta ou o SDK é bem-sucedido com o tipo de autenticação que tenta, a ferramenta ou o SDK para de tentar autenticar com os tipos de autenticação restantes. Para forçar um SDK a autenticar com um tipo específico de autenticação, defina o campo do tipo de autenticação do Databricks da API de Config.

  1. Autenticação de token de acesso pessoal do Azure Databricks
  2. Autenticação OAuth máquina a máquina (M2M)
  3. Autenticação U2M (usuário para computador) do OAuth
  4. Autenticação de identidades gerenciadas do Azure
  5. Autenticação de entidades de serviço do Microsoft Entra ID
  6. Autenticação da CLI do Azure

Para cada tipo de autenticação que a ferramenta participante ou o SDK tenta, a ferramenta ou o SDK tenta localizar credenciais de autenticação nos locais a seguir, na ordem a seguir. Quando a ferramenta ou o SDK consegue encontrar credenciais de autenticação que podem ser usadas, a ferramenta ou o SDK para de tentar localizar credenciais de autenticação nos locais restantes.

  1. Campos da API de Config relacionados a credenciais (para SDKs). Para definir campos de Config, consulte os Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks ou a documentação de referência do SDK.
  2. Variáveis de ambiente relacionadas à credencial. Para definir variáveis de ambiente, consulte os Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks e a documentação do sistema operacional.
  3. Os campos relacionados a credenciais no perfil de configuração DEFAULT dentro do arquivo .databrickscfg. Para definir campos de perfil de configuração, consulte os Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks e (perfis de #config).
  4. Todas as credenciais de autenticação relacionadas que são armazenadas em cache pela CLI do Azure. Confira a CLI do Azure.

Para oferecer o máximo de portabilidade para seu código, o Databricks recomenda a criação de um perfil de configuração personalizado no arquivo .databrickscfg, adicione os campos obrigatórios para o tipo de autenticação de destino do Databricks ao perfil de configuração personalizado e, em seguida, defina a variável de ambiente DATABRICKS_CONFIG_PROFILE como o nome do perfil de configuração personalizado. Para obter mais informações, consulte os Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks.

Variáveis de ambiente e campos para autenticação unificada do cliente

As tabelas a seguir listam os nomes e descrições das variáveis de ambiente e dos campos com suporte para a autenticação unificada do cliente do Databricks. Nas tabelas a seguir:

Os campos e as variáveis de ambiente da ID de conta, token e host geral

Nome comum Descrição Variável de ambiente O campo de .databrickscfg, campo do Terraform Campo de Config
Host do Azure Databricks (Cadeia de caracteres) A URL do host do Azure Databricks para o ponto de extremidade do workspace do Azure Databricks ou o ponto de extremidade de contas do Azure Databricks. DATABRICKS_HOST host host (Python),
setHost (Java),
Host (Go)
Token do Azure Databricks (Cadeia de caracteres) O token de acesso pessoal do Azure Databricks ou o token do Microsoft Entra ID. DATABRICKS_TOKEN token token (Python),
setToken (Java),
Token (Go)
ID da conta do Azure Databricks (Cadeia de caracteres) A ID da conta do Azure Databricks para o ponto de extremidade da conta do Azure Databricks. Só tem efeito quando o host do Azure Databricks também está definido como
https://accounts.azuredatabricks.net.		 DATABRICKS_ACCOUNT_ID account_id account_id (Python),
setAccountID (Java),
AccountID (Go)

Campos e variáveis de ambiente específicos do Azure

Nome comum Descrição Variável de ambiente O campo de .databrickscfg, campo do Terraform Campo de Config
ID do cliente do Azure (Cadeia de Caracteres) A ID do aplicativo do principal do serviço Microsoft Entra ID. Use com a autenticação de identidades gerenciadas do Azure e a autenticação da entidade de serviço do Microsoft Entra ID. ARM_CLIENT_ID azure_client_id azure_client_id (Python),
setAzureClientID (Java),
AzureClientID (Go)
Segredo do cliente do Azure (Cadeia de caracteres) O segredo do cliente da entidade de serviço do Microsoft Entra ID. Use com uma autenticação de entidade de serviço do Microsoft Entra ID. ARM_CLIENT_SECRET azure_client_secret azure_client_secret (Python),
setAzureClientSecret (Java),
AzureClientSecret (Go)
ID do Cliente (Cadeia de caracteres) O ID do cliente do principal de serviço gerenciado do Azure Databricks ou do principal de serviço gerenciado do Microsoft Entra ID. Use com a autenticação OAuth M2M. DATABRICKS_CLIENT_ID client_id client_id (Python),
setClientId (Java),
ClientId (Go)
Segredo do cliente (Cadeia de caracteres) O segredo do cliente da entidade de serviço gerenciado do Azure Databricks ou da entidade de serviço gerenciada do Microsoft Entra ID. Use com a autenticação OAuth M2M. DATABRICKS_CLIENT_SECRET client_secret client_secret (Python),
setClientSecret (Java),
ClientSecret (Go)
Ambiente do Azure (Cadeia de caracteres) O tipo de ambiente do Azure. Usa PUBLIC como padrão. ARM_ENVIRONMENT azure_environment azure_environment (Python),
setAzureEnvironment (Java),
AzureEnvironment (Go)
ID do locatário do Azure (Cadeia de caracteres) A ID de locatário do entidade de serviço do Microsoft Entra ID. ARM_TENANT_ID azure_tenant_id azure_tenant_id (Python),
setAzureTenantID (Java),
AzureTenantID (Go)
O Azure usa MSI (Booliano) True para usar o fluxo de autenticação sem senha da Identidade de Serviço Gerenciado do Azure para entidades de serviço. Requer que a ID do recurso do Azure também seja definida. ARM_USE_MSI azure_use_msi AzureUseMSI (Go)
ID do recurso do Azure (Cadeia de caracteres) A ID do Azure Resource Manager para o workspace do Azure Databricks. DATABRICKS_AZURE_RESOURCE_ID azure_workspace_resource_id azure_workspace_resource_id (Python),
setAzureResourceID (Java),
AzureResourceID (Go)

Campos e variáveis de ambiente específicos de .databrickscfg

Use essas variáveis de ambiente ou campos para especificar configurações não padrão de .databrickscfg. Confira também Perfis de configuração do Azure Databricks.

Nome comum Descrição Variável de ambiente Campo do Terraform Campo de Config
Caminho de arquivo de .databrickscfg (Cadeia de caracteres) Um caminho não padrão para o
arquivo .databrickscfg.		 DATABRICKS_CONFIG_FILE config_file config_file (Python),
setConfigFile (Java),
ConfigFile (Go)
Perfil padrão de .databrickscfg (Cadeia de caracteres) O perfil nomeado padrão a ser usado, além de DEFAULT. DATABRICKS_CONFIG_PROFILE profile profile (Python),
setProfile (Java),
Profile (Go)

Campo de tipo de autenticação

Use essa variável de ambiente ou campo para forçar um SDK a usar um tipo específico de autenticação do Databricks.

Nome comum Descrição Campo do Terraform Campo de Config
Tipo de autenticação do Databricks (Cadeia de caracteres) Quando vários atributos de autenticação estiverem disponíveis no ambiente, use o tipo de autenticação especificado por esse argumento. auth_type auth_type (Python),
setAuthType (Java),
AuthType (Go)

Os valores do campo de tipo de autenticação do Databricks com suporte incluem:

Perfis de configuração do Azure Databricks

Um perfil de configuração do Azure Databricks (às vezes chamado de perfil de configuração, perfil de configuração ou simplesmente a profile) contém configurações e outras informações que o Azure Databricks precisa para autenticar. Os perfis de configuração do Azure Databricks são armazenados em arquivos de perfis de configuração do Azure Databricks para as ferramentas, SDKs, scripts e aplicativos a serem usados. Para saber se os perfis de configuração do Azure Databricks são compatíveis com as ferramentas, SDKs, scripts e aplicativos, consulte a documentação do provedor. Todas as ferramentas e SDKs participantes que implementam a autenticação unificada do cliente do Databricks dão suporte a perfis de configuração do Azure Databricks. Para obter mais informações, consulte os Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks.

Para criar um arquivo de perfis de configuração do Azure Databricks:

  1. Use seu editor de texto favorito para criar um arquivo nomeado como .databrickscfg em sua pasta ~ (sua página inicial do usuário) no Unix, Linux ou macOS, ou em sua pasta %USERPROFILE% (sua página inicial do usuário) no Windows, se ainda não tiver uma. Não se esqueça do ponto (.) no início do nome do arquivo. Adicione o seguinte conteúdo ao arquivo:

    [<some-unique-name-for-this-configuration-profile>]
<field-name> = <field-value>

  2. No conteúdo anterior, substitua os valores a seguir e, em seguida, salve o arquivo:

    • <some-unique-name-for-this-configuration-profile> por um nome exclusivo para o perfil de configuração, tal como DEFAULT, DEVELOPMENT, PRODUCTION ou semelhante. Você pode ter vários perfis de configuração no mesmo arquivo .databrickscfg, mas cada perfil de configuração deve ter um nome exclusivo nesse arquivo.
    • <field-name> e <field-value> com o nome e um valor para um dos campos obrigatórios para o tipo de autenticação de destino do Databricks. Para obter as informações específicas a serem fornecidas, confira a seção anterior deste artigo sobre esse tipo de autenticação.
    • Adicione um par de <field-name> e <field-value> para cada um dos campos obrigatórios adicionais para o tipo de autenticação de destino do Databricks.

Por exemplo, para a autenticação de token de acesso pessoal do Azure Databricks, o arquivo .databrickscfg pode ter a seguinte aparência:

[DEFAULT]
host  = https://adb-1234567890123456.7.azuredatabricks.net
token = dapi123...

Para criar perfis de configuração adicionais, especifique nomes de perfis diferentes no mesmo arquivo .databrickscfg. Por exemplo, para especificar workspaces do Azure Databricks separados, cada um com seu próprio token de acesso pessoal do Azure Databricks:

[DEFAULT]
host  = https://adb-1234567890123456.7.azuredatabricks.net
token = dapi123...

[DEVELOPMENT]
host  = https://adb-2345678901234567.8.azuredatabricks.net
token = dapi234...

Você também pode especificar diferentes nomes de perfil no arquivo .databrickscfg para contas do Azure Databricks e diferentes tipos de autenticação do Databricks, por exemplo:

[DEFAULT]
host  = https://adb-1234567890123456.7.azuredatabricks.net
token = dapi123...

[DEVELOPMENT]
azure_workspace_resource_id = /subscriptions/bc0cd1.../resourceGroups/my-resource-group/providers/Microsoft.Databricks/workspaces/my-workspace
azure_tenant_id             = bc0cd1...
azure_client_id             = fa0cd1...
azure_client_secret         = aBC1D~...

ODBC DSNs

No ODBC, um DSN (nome de fonte de dados) é um nome simbólico que ferramentas, SDKs, scripts e aplicativos usam para solicitar uma conexão com uma fonte de dados ODBC. Um DSN armazena detalhes de conexão, como o caminho para um driver ODBC, detalhes de rede, credenciais de autenticação e detalhes do banco de dados. Para saber se DSNs de ODBC têm suporte nas ferramentas, scripts e aplicativos, consulte a documentação do provedor.

Para instalar e configurar o Driver ODBC do Databricks e criar um ODBC DSN para o Azure Databricks, confira Driver ODBC do Databricks.

URLs de conexão JDBC

No JDBC, uma URL de conexão é uma URL simbólica que ferramentas, SDKs, scripts e aplicativos usam para solicitar uma conexão com uma fonte de dados JDBC. Uma URL de conexão armazena detalhes de conexão, como detalhes de rede, credenciais de autenticação, detalhes do banco de dados e recursos do driver JDBC. Para saber se URLs de conexão de JDBC são compatíveis com as ferramentas, SDKs, scripts e aplicativos, consulte a documentação do provedor.

Para instalar e configurar o Driver JDBC do Databricks e criar uma URL de conexão JDBC para o Azure Databricks, confira Driver JDBC do Databricks.

Microsoft Entra ID (antigo Azure Active Directory)

Os tokens do Microsoft Entra ID (antigo Azure Active Directory) são um dos tipos de credenciais mais bem suportados pelo Azure Databricks, tanto no workspace do Azure Databricks quanto no nível da conta Microsoft.

Observação

Algumas ferramentas, SDKs, scripts e aplicativos dão suporte apenas à autenticação de token de acesso pessoal do Azure Databricks e não aos tokens do Microsoft Entra ID. Para saber se os tokens do Microsoft Entra ID têm suporte pelas ferramentas, SDKs, scripts e aplicativos, consulte os Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks ou a documentação do provedor.

Além disso, algumas ferramentas, SDK, scripts e aplicativos dão suporte a tokens OAuth do Azure Databricks, além ou em vez de tokens do Microsoft Entra ID para autenticação do Azure Databricks. Para saber se os tokens OAuth do Azure Databricks têm suporte pelas ferramentas, SDKs, scripts e aplicativos, consulte os Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks ou a documentação do provedor.

Autenticação por token do Microsoft Entra ID para usuários

O Databricks não recomenda que você crie manualmente tokens do Microsoft Entra ID para usuários do Azure Databricks. Isso ocorre porque cada token do Microsoft Entra ID tem curta duração, normalmente expirando em uma hora. Após esse tempo, você precisará gerar manualmente um token de substituição do Microsoft Entra ID. Em vez disso, use uma das ferramentas ou SDKs participantes que implementam o padrão de autenticação unificada do cliente Databricks. Essas ferramentas e SDKs geram e substituem automaticamente os tokens expirados do Microsoft Entra ID, aproveitando os seguintes tipos de autenticação da CLI do Azure.

Se você precisar criar manualmente um token do Microsoft Entra ID para um usuário do Azure Databricks, consulte:

Autenticação por token do Microsoft Entra ID para entidades de serviço

O Databricks não recomenda criar manualmente tokens do Microsoft Entra ID para entidades de serviço do Microsoft Entra ID. Isso ocorre porque cada token do Microsoft Entra ID tem curta duração, normalmente expirando em uma hora. Após esse tempo, você precisará gerar manualmente um token de substituição do Microsoft Entra ID. Em vez disso, use uma das ferramentas ou SDKs participantes que implementam o padrão de autenticação unificada do cliente Databricks. Essas ferramentas e SDKs geram e substituem automaticamente os tokens expirados do Microsoft Entra ID, aproveitando os seguintes tipos de autenticação do Databricks:

Se você precisar criar manualmente um token do Microsoft Entra ID para uma entidade de serviço do Microsoft Entra ID, consulte:

CLI do Azure

A CLI do Azure permite a você se autenticar com o Azure Databricks por meio do PowerShell, pelo do terminal para Linux ou macOS ou por meio do Prompt de Comando para Windows. Para saber se a CLI do Azure tem suporte pelas ferramentas, SDKs, scripts e aplicativos, consulte os Tipos de autenticação com suporte pela ferramenta ou SDK do Azure Databricks ou a documentação do provedor.

Para usar a CLI do Azure para se autenticar manualmente no Azure Databricks, execute o comando az login:

az login

Para se autenticar usando uma entidade de serviço do Microsoft Entra ID, consulte o Logon da CLI do Azure com uma entidade de serviço do Microsoft Entra ID.

Para autenticar usando uma conta de usuário do Azure Databricks gerenciada pelo Azure, veja Login da CLI do Azure com uma conta de usuário do Azure Databricks.