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

Esta referência lista os campos de configuração e variáveis de ambiente para a autenticação unificada do clienteDatabricks. Eles funcionam de forma consistente na CLI da Databricks, no provedor Terraform e nos SDKs para Python, Java e Go.

Use essa referência para configurar a autenticação ou solucionar problemas de autenticação. Cada entrada inclui:

• variável de ambiente: Defina isso em seu ambiente shell.
• Campo.databrickscfg: Use isso nos perfis de configuração.
• Campo do Terraform: Configure isso em seu bloco de provedor do Terraform. Consulte Autenticação na documentação do provedor Databricks Terraform.
• Config field: Use-o ao configurar SDKs programaticamente com a API Config.

Campos de configuração geral

Essas variáveis definem as configurações básicas de conexão e compute para Databricks.

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.cloud.databricks.com.	DATABRICKS_ACCOUNT_ID	account_id	account_id (Python) setAccountID (Java) AccountID (Ir)
clusterId	(strings) O ID do site cluster a ser usado	DATABRICKS_CLUSTER_ID	cluster_id	cluster_id
computação sem servidor	(strings) A configuração de ativação automática do serverless compute . Os valores válidos são auto.	DATABRICKS_SERVERLESS_COMPUTE_ID	serverless_compute_id	serverless_compute_id

Campos de usuário e entidade de serviço

Essas variáveis configuram a autenticação com os nomes de usuário Databricks e a entidade de serviço.

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

campos específicos de.databrickscfg

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	(String) Um caminho não padrão para o arquivo .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)

Campos de autenticação

Use esses campos ou variáveis de ambiente para impor um tipo específico de autenticação Databricks.

Nome comum	Descrição	Variável de ambiente	Campo Terraform	Config campo
Tipo de autenticação de databricks	(strings) Quando vários atributos de autenticação estiverem disponíveis no ambiente, use o tipo de autenticação especificado por esse argumento. Consulte Tipos de autenticação compatíveis.	DATABRICKS_AUTH_TYPE	auth_type	auth_type (Python) setAuthType (Java) AuthType (Ir)
Tokens OIDC variáveis de ambiente	(strings) O nome da variável de ambiente que contém seus tokens OIDC emitidos pelo IdP. Usado com o tipo de autenticação env-oidc. padrão para DATABRICKS_OIDC_TOKEN.	DATABRICKS_OIDC_TOKEN_ENV	oidc_token_env	oidc_token_env (Python) setOIDCTokenEnv (Java) OIDCTokenEnv (Ir)
Caminho do arquivo de tokens OIDC	(strings) O caminho para um arquivo local que contém seus tokens OIDC emitidos pelo IdP. Usado com o tipo de autenticação file-oidc.	DATABRICKS_OIDC_TOKEN_FILEPATH	oidc_token_filepath	oidc_token_filepath (Python) setOIDCTokenFilepath (Java) OIDCTokenFilepath (Ir)

Tipos de autenticação compatíveis

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

• oauth-m2m: Use para autenticação máquina a máquina (M2M) com uma entidade de serviço Databricks por meio do OAuth 2.0. Consulte Autorizar o acesso da entidade de serviço ao Databricks com o OAuth.
• pat: Use se o senhor se autenticar com um Databricks pessoal access token. Consulte Databricks autenticação pessoal access token.
• databricks-cli: Use se estiver fazendo login interativamente com o Databricks CLI e o OAuth 2.0. Consulte Autorizar o acesso do usuário ao Databricks com o OAuth.
• oidc-token: Use para federação de tokens com um provedor de identidade (IdP), em que Databricks troca tokens OIDC emitidos pelo IdP por tokens Databricks OAuth . Consulte Autenticar o acesso ao Databricks usando a federação de tokens OAuth.
• env-oidc: Use se os tokens do IdP estiverem armazenados em uma variável de ambiente (padrão: DATABRICKS_OIDC_TOKEN). Consulte Autenticar o acesso a Databricks usando a federação de tokens OAuth.
• file-oidc: Use se os tokens do IdP estiverem armazenados em um arquivo local, referenciado por DATABRICKS_OIDC_TOKEN_FILEPATH. Consulte Autenticar o acesso ao Databricks usando a federação de tokens OAuth.
• github-oidc: Use para autenticação federada GitHub Actions, em que GitHub emite tokens OIDC que Databricks troca por tokens Databricks OAuth . Para obter um exemplo, consulte Habilitar a federação de identidade de carga de trabalho em CI/CD.