Teilen über


Umgebungsvariablen und Felder für die einheitliche Authentifizierung

In dieser Referenz werden Umgebungsvariablen und Konfigurationsfelder für die einheitliche Databricks-Authentifizierung aufgelistet. Sie arbeiten konsistent über die Databricks CLI, den Terraform-Anbieter und SDKs für Python, Java und Go.

Verwenden Sie diesen Verweis, um die Authentifizierung einzurichten oder Authentifizierungsprobleme zu beheben. Jeder Eintrag umfasst:

  • Umgebungsvariable: Legen Sie dies in Ihrer Shellumgebung fest.
  • .databrickscfg Feld: Verwenden Sie dies in Konfigurationsprofilen.
  • Terraform-Feld: Konfigurieren Sie dies in Ihrem Terraform-Anbieterblock. Siehe Authentifizierung in der Databricks Terraform-Anbieterdokumentation.
  • Config Feld: Verwenden Sie dies, wenn Sie SDKs programmgesteuert mit der Config API konfigurieren.

Allgemeine Konfigurationsfelder

Diese Variablen konfigurieren grundlegende Verbindungs- und Computeeinstellungen für Databricks.

Allgemeiner Name Description Umgebungsvariable .databrickscfg-Field, Terraform-Feld Config-Feld
Azure Databricks-Host (Zeichenfolge) Die Azure Databricks-Host-URL für den Azure Databricks-Arbeitsbereichsendpunkt oder den Azure Databricks-Kontenendpunkt. DATABRICKS_HOST host host (Python)
setHost (Java)
Host (Los)
Azure Databricks-Token (Zeichenfolge) Das persönliche Azure Databricks-Zugriffstoken oder das Microsoft Entra ID-Token. DATABRICKS_TOKEN token token (Python)
setToken (Java)
Token (Los)
Azure Databricks-Konto-ID (Zeichenfolge) Die Azure Databricks-Konto-ID für den Azure Databricks-Kontoendpunkt. Hat nur Auswirkungen, wenn der Azure Databricks-Host auch auf https://accounts.azuredatabricks.net gesetzt ist. DATABRICKS_ACCOUNT_ID account_id account_id (Python)
setAccountID (Java)
AccountID (Los)
Cluster-ID (Zeichenfolge) Die ID des zu verwendenden Clusters DATABRICKS_CLUSTER_ID cluster_id cluster_id
Serverloses Rechnen (Zeichenfolge) Die Einstellung für die automatische Aktivierung ohne Server. Gültige Werte sind auto. DATABRICKS_SERVERLESS_COMPUTE_ID serverless_compute_id serverless_compute_id
Allgemeiner Name Description Umgebungsvariable .databrickscfg-Field, Terraform-Feld Config-Feld
Azure-Kunden-ID (Zeichenfolge) Die Anwendungs-ID des Microsoft Entra ID-Dienstprinzipals. Wird für die Authentifizierung mit von Azure verwalteten Identitäten und die Microsoft Entra ID-Dienstprinzipalauthentifizierung verwendet. ARM_CLIENT_ID azure_client_id azure_client_id (Python)
setAzureClientID (Java)
AzureClientID (Los)
Geheimer Azure-Clientschlüssel (Zeichenfolge) Der geheime Clientschlüssel des Microsoft Entra ID-Dienstprinzipals. Wird mit der Microsoft Entra ID-Dienstprinzipalauthentifizierung verwendet. ARM_CLIENT_SECRET azure_client_secret azure_client_secret (Python)
setAzureClientSecret (Java)
AzureClientSecret (Los)
Kunden-ID (Zeichenfolge) Die Client-ID des von Azure Databricks verwalteten Dienstprinzipals oder des von Microsoft Entra ID verwalteten Dienstprinzipals. Wird mit der OAuth M2M-Authentifizierung verwendet. DATABRICKS_CLIENT_ID client_id client_id (Python)
setClientId (Java)
ClientId (Los)
Geheimer Clientschlüssel (Zeichenfolge) Der geheime Clientschlüssel des von Azure Databricks verwalteten Dienstprinzipals oder des von Microsoft Entra ID verwalteten Dienstprinzipals. Wird mit der OAuth M2M-Authentifizierung verwendet. DATABRICKS_CLIENT_SECRET client_secret client_secret (Python)
setClientSecret (Java)
ClientSecret (Los)
Azure-Umgebung (Zeichenfolge) Der Azure-Umgebungstyp. Wird standardmäßig auf PUBLIC festgelegt. ARM_ENVIRONMENT azure_environment azure_environment (Python)
setAzureEnvironment (Java)
AzureEnvironment (Los)
Azure Mandanten-ID (Zeichenfolge) Die Mandanten-ID des Microsoft Entra ID-Dienstprinzipals. ARM_TENANT_ID azure_tenant_id azure_tenant_id (Python)
setAzureTenantID (Java)
AzureTenantID (Los)
Azure verwendet MSI (Boolescher Wert) True, um den kennwortlosen Authentifizierungsflow der verwalteten Azure-Dienstidentität für Dienstprinzipale zu verwenden. Erfordert, dass auch die Azure-Ressourcen-ID festgelegt ist. ARM_USE_MSI azure_use_msi AzureUseMSI (Los)
Azure-Ressourcen-ID (Zeichenfolge) Die Azure Resource Manager-ID für den Azure Databricks-Arbeitsbereich. DATABRICKS_AZURE_RESOURCE_ID azure_workspace_resource_id azure_workspace_resource_id (Python)
setAzureResourceID (Java)
AzureResourceID (Los)

.databrickscfg-spezifische Felder

Verwenden Sie diese Umgebungsvariablen oder Felder, um nicht standardmäßige Einstellungen für .databrickscfg anzugeben. Siehe auch Azure Databricks-Konfigurationsprofile.

Allgemeiner Name Description Umgebungsvariable Terraform-Feld Config-Feld
.databrickscfg-Dateipfad (Zeichenfolge) Ein nicht standardmäßiger Pfad zur .databrickscfg Datei. DATABRICKS_CONFIG_FILE config_file config_file (Python)
setConfigFile (Java)
ConfigFile (Los)
.databrickscfg-Standardprofil (Zeichenfolge) Das standardmäßig benannte Profil, das verwendet werden soll, außer DEFAULT. DATABRICKS_CONFIG_PROFILE profile profile (Python)
setProfile (Java)
Profile (Los)

Authentifizierungsfelder

Verwenden Sie diese Umgebungsvariablen oder -felder, um eine bestimmte Art der Databricks-Authentifizierung zu erzwingen.

Allgemeiner Name Description Umgebungsvariable Terraform-Feld Config-Feld
Databricks-Authentifizierungstyp (Zeichenfolge) Wenn in der Umgebung mehrere Authentifizierungsattribute verfügbar sind, verwenden Sie den von diesem Argument angegebenen Authentifizierungstyp. Siehe unterstützte Authentifizierungstypen. DATABRICKS_AUTH_TYPE auth_type auth_type (Python)
setAuthType (Java)
AuthType (Los)
OIDC-Tokenumgebungsvariable (Zeichenfolge) Der Name der Umgebungsvariable, die Ihr idP-ausgestelltes OIDC-Token enthält. Wird mit env-oidc Authentifizierungstyp verwendet. Wird standardmäßig auf DATABRICKS_OIDC_TOKEN festgelegt. DATABRICKS_OIDC_TOKEN_ENV oidc_token_env oidc_token_env (Python)
setOIDCTokenEnv (Java)
OIDCTokenEnv (Los)
OIDC-Tokendateipfad (Zeichenfolge) Der Pfad zu einer lokalen Datei, die Ihr idP-ausgestelltes OIDC-Token enthält. Wird mit file-oidc Authentifizierungstyp verwendet. DATABRICKS_OIDC_TOKEN_FILEPATH oidc_token_filepath oidc_token_filepath (Python)
setOIDCTokenFilepath (Java)
OIDCTokenFilepath (Los)

Unterstützte Authentifizierungstypen

Zu den unterstützten Feldwerten des Databricks-Authentifizierungstyps gehören: