Autenticação unificada do cliente Databricks

A autenticação unificada do cliente Databricks centraliza a configuração e a automatização da autenticação no Databricks como parte da autorização OAuth. Ele 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.

Ferramentas e SDKs participantes

As ferramentas e SDKs participantes do Databricks são:

Todas as ferramentas e SDKs participantes aceitam perfis especiais de configuração variável de ambiente e Databricks para autenticação. O provedor Terraform da Databricks e os SDKs da 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, consulte Ferramentas de desenvolvimento local para a documentação da ferramenta ou do SDK.

Métodos padrão para autenticação unificada de cliente

Sempre que uma ferramenta ou SDK precisa autorizar o acesso a Databricks, ela tenta os seguintes tipos de autenticação na seguinte ordem por default. Quando a ferramenta ou o SDK é bem-sucedido com o tipo de autenticação que tenta, ele para de tentar se autenticar com os tipos de autenticação restantes. Para forçar um SDK a se autenticar com um tipo de autenticação específico, defina o campo Config API's Databricks authentication type.

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

Campos de API Config relacionados a credenciais (para SDKs).
Variáveis de ambiente relacionadas a credenciais.
Campos relacionados à credencial no perfil de configuração DEFAULT no arquivo .databrickscfg. Para definir os campos do perfil de configuração, consulte (/dev-tools/auth/config-profiles.md).

Para oferecer o máximo de portabilidade ao seu código, a Databricks recomenda que o senhor crie um perfil de configuração personalizado dentro do arquivo .databrickscfg, adicione os campos obrigatórios abaixo para o tipo de autenticação de destino da 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.

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

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

Variável de ambiente, quando aplicável, é o nome da variável de ambiente.
.databrickscfg field, quando aplicável, é o nome do campo em um arquivo de perfis de configuração do Databricks ou na configuração do Databricks Terraform. Para definir os campos .databrickscfg, consulte Perfis de configuração do Databricks.
Campo Terraform, quando aplicável, é o nome do campo dentro de uma configuração Databricks Terraform. Para definir campos Terraform Databricks, consulte Autenticação na documentação do provedor Databricks Terraform.
O campoConfig é o nome do campo na API Config para o SDK especificado.

Variáveis e campos gerais de ambiente de host, token e ID de conta

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

Variáveis de ambiente e campos específicos da AWS

Nome comum	Descrição	Variável de ambiente	`.databrickscfg` campo, campo de Terraform	`Config` campo
Nome de usuário do Databricks	(String) O nome de usuário do Databricks.	`DATABRICKS_USERNAME`	`username`	`username` (Python), `setUsername` (Java), `Username` (Go)
ID do cliente principal do serviço	(String) O ID do cliente da entidade de serviço do Databricks.	`DATABRICKS_CLIENT_ID`	`client_id`	`client_id` (Python), `setClientId` (Java), `ClientId` (Go)
Segredo principal do serviço	(String) O segredo da entidade de serviço do Databricks.	`DATABRICKS_CLIENT_SECRET`	`client_secret`	`client_secret` (Python), `setClientSecret` (Java), `ClientSecret` (Go)

.databrickscfg specific variável de ambientes e campos

Utilize estas variáveis de ambiente ou campos para especificar configurações não padrão do .databrickscfg. Veja também Perfis de configuração do Databricks.

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

Campo Tipo de autenticação

Utilize 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 Terraform	`Config` campo
Tipo de autenticação de databricks	(String) Se houver múltiplos atributos de autenticação disponíveis no ambiente, utilize o tipo de autenticação especificado por este argumento.	`auth_type`	`auth_type` (Python), `setAuthType` (Java), `AuthType` (Go)

Os valores de campo do tipo de autenticação do Databricks compatíveis incluem:

oauth-m2m: Defina esse valor se estiver usando uma entidade de serviço Databricks para autenticação M2M com OAuth 2.0. Para obter mais detalhes, consulte Autorizar o acesso autônomo a Databricks recurso com uma entidade de serviço usando OAuth.
pat: Defina esse valor se o senhor estiver usando o Databricks pessoal access tokens. Para obter mais detalhes, consulte Databricks personal access token authentication.
databricks-cli: Defina esse valor se estiver usando a CLI da Databricks com OAuth 2.0. Para obter mais detalhes, consulte Autorizar o acesso interativo ao recurso Databricks com um usuário account usando OAuth.