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:

• A CLI da Databricks
• O provedor Terraform da Databricks
• Databricks Connect
• A extensão Databricks para o Visual Studio Code
• O SDK da Databricks para Python
• O SDK da Databricks para Java
• O SDK da Databricks para Go

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 clientes

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.

1. Autenticação de access tokens pessoais do Databricks
2. Autorizar o acesso autônomo a Databricks recurso com uma entidade de serviço usando OAuth
3. Autorize o acesso interativo a Databricks recurso com um usuário account usando OAuth
4. Autenticação de credenciais do Google Cloud
5. Autenticação de ID do Google Cloud

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.

1. Campos da API Config relacionados a credenciais (para SDKs). Para definir os campos do site Config, consulte a documentação de referência do SDK.
2. Variáveis de ambiente relacionadas a credenciais.
3. 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).
4. Todas as credenciais de autenticação relacionadas que são armazenadas em cache pela CLI do Google Cloud. Consulte Autenticação do Google Cloud ID.

Para oferecer o máximo de portabilidade para o seu código, a Databricks recomenda que o senhor crie um perfil de configuração personalizado no 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 com o nome do perfil de configuração personalizado.

variável de ambiente e campos para autenticação unificada de clientes

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 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 do site .databrickscfg, consulte Perfis de configuração do Databricks.
• O 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.

Host geral, tokens e account ID variável de ambiente e campos

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 (Ir)
Token de Databricks	(String) O token de acesso pessoal do Databricks.	DATABRICKS_TOKEN	token	token (Python), setToken (Java), Token (Ir)
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.gcp.databricks.com.	DATABRICKS_ACCOUNT_ID	account_id	account_id (Python), setAccountID (Java), AccountID (Ir)

Variável de ambiente e campos específicos do Google Cloud

Nome comum	Descrição	Variável de ambiente	.databrickscfg campo, campo de Terraform	Config campo
ID do cliente	(strings) O ID do cliente da Databricks entidade de serviço.	DATABRICKS_CLIENT_ID	client_id	client_id (Python), setClientId (Java), ClientId (Ir)
Segredo do cliente	(strings) O segredo do cliente da Databricks entidade de serviço.	DATABRICKS_CLIENT_SECRET	client_secret	client_secret (Python), setClientSecret (Java), ClientSecret (Ir)
Conta de serviço do Google Cloud	(String) Endereço de e-mail da conta de serviço do Google Cloud.	DATABRICKS_GOOGLE_SERVICE_ACCOUNT	google_service_acccount	GoogleServiceAccount (Ir)
Credenciais do Google Cloud	(String) O caminho local para o arquivo de chave da conta de serviço do Google Cloud, ou o conteúdo do arquivo de chave da conta de serviço no formato JSON.	GOOGLE_CREDENTIALS	google_credentials	GoogleCredentials (Ir)

.databrickscfg-specific variável de ambiente e campos

Use esses campos para especificar configurações nãodefault para .databrickscfg. Consulte também Perfis de configuração do Databricks.

Nome comum	Descrição	Variável de ambiente	Campo Terraform	Config campo
.databrickscfg caminho do arquivo	(strings) Um caminho nãodefault para o .databrickscfg .	DATABRICKS_CONFIG_FILE	config_file	config_file (Python), setConfigFile (Java), ConfigFile (Ir)
.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 (Ir)

Campo de 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 (Ir)

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 tokens de acesso pessoal da Databricks. Para obter mais detalhes, consulte Databricks autenticação de tokens de acesso pessoal.

• databricks-cli: Defina esse valor se estiver usando o Databricks CLI com OAuth 2.0. Para obter mais detalhes, consulte Autorizar o acesso interativo ao recurso Databricks com um usuário account usando OAuth.

• google-id: defina esse valor se você estiver autenticando o acesso usando um ID do Google. Para obter mais detalhes, consulte Autenticação do Google Cloud ID.