Bagikan melalui

Autentikasi terpadu klien Databricks

  • Artikel

Autentikasi terpadu klien Databricks mempusatkan pengaturan dan mengotomatiskan autentikasi ke Azure Databricks sebagai bagian dari otorisasi OAuth. Ini memungkinkan Anda untuk mengonfigurasi autentikasi Databricks sekali dan kemudian menggunakan konfigurasi tersebut di beberapa alat Databricks dan SDK tanpa perubahan konfigurasi autentikasi lebih lanjut.

Alat dan SDK yang berpartisipasi

Alat dan SDK Databricks yang berpartisipasi meliputi:

Semua alat dan SDK yang berpartisipasi menerima variabel lingkungan khusus dan profil konfigurasi Azure Databricks untuk autentikasi. Penyedia Databricks Terraform dan SDK Databricks untuk Python, Java, dan Go juga menerima konfigurasi langsung pengaturan autentikasi dalam kode. Untuk detailnya, lihat Alat pengembangan lokal untuk dokumentasi alat atau SDK.

Metode default untuk autentikasi terpadu klien

Setiap kali alat atau SDK harus mengotorisasi akses ke Azure Databricks, alat atau SDK harus mencoba jenis autentikasi berikut dalam urutan berikut secara default. Ketika alat atau SDK berhasil dengan jenis autentikasi yang dicobanya, alat berhenti mencoba mengautentikasi dengan jenis autentikasi yang tersisa. Untuk memaksa SDK mengautentikasi dengan jenis autentikasi tertentu, atur bidang jenis autentikasi Databricks API Config.

  1. Autentikasi token akses pribadi Azure Databricks
  2. Mengotorisasi akses tanpa pengawasan ke sumber daya Azure Databricks dengan perwakilan layanan menggunakan OAuth
  3. Mengotorisasi akses interaktif ke sumber daya Azure Databricks dengan akun pengguna menggunakan OAuth
  4. Autentikasi identitas terkelola Azure
  5. Autentikasi perwakilan layanan MS Entra
  6. Autentikasi Azure CLI

Untuk setiap jenis autentikasi yang diuji alat atau SDK yang berpartisipasi, alat atau SDK mencoba menemukan kredensial autentikasi di lokasi berikut, dalam urutan berikut. Ketika alat atau SDK berhasil menemukan kredensial autentikasi yang dapat digunakan, alat atau SDK berhenti mencoba menemukan kredensial autentikasi di lokasi yang tersisa.

  1. Bidang API terkait Config kredensial (untuk SDK). Untuk mengatur bidang Config, lihat dokumentasi referensi SDK.
  2. Variabel lingkungan terkait kredensial.
  3. Bidang terkait kredensial di DEFAULT profil konfigurasi dalam .databrickscfg file. Untuk mengatur bidang profil konfigurasi, lihat (/dev-tools/auth/config-profiles.md).
  4. Setiap kredensial autentikasi terkait yang di-cache oleh Azure CLI. Lihat Autentikasi Azure CLI.

Untuk memberikan portabilitas maksimum untuk kode Anda, Databricks menyarankan agar Anda membuat profil konfigurasi kustom dalam file .databrickscfg, tambahkan bidang yang diperlukan di bawah ini untuk jenis autentikasi Databricks target Anda ke profil konfigurasi kustom, lalu atur variabel lingkungan DATABRICKS_CONFIG_PROFILE ke nama profil konfigurasi kustom.

Variabel dan bidang lingkungan untuk autentikasi terpadu klien

Tabel berikut mencantumkan nama dan deskripsi variabel dan bidang lingkungan yang didukung untuk autentikasi terpadu klien Databricks. Dalam tabel berikut:

  • Variabel lingkungan, jika berlaku, adalah nama variabel lingkungan.
  • .databrickscfg bidang, jika berlaku, adalah nama bidang dalam file profil konfigurasi Azure Databricks atau konfigurasi Databricks Terraform. Untuk mengatur bidang .databrickscfg, lihat profil konfigurasi Azure Databricks.
  • bidang Terraform, jika berlaku, adalah nama bidang dalam konfigurasi Databricks Terraform. Untuk mengatur bidang Databricks Terraform, lihat Autentikasi dalam dokumentasi penyedia Databricks Terraform.
  • Config bidang adalah nama bidang dalam Config API untuk SDK yang ditentukan.

Host umum, token, dan variabel dan bidang lingkungan ID akun

Nama umum Deskripsi Variabel lingkungan .databrickscfg bidang, bidang Terraform Config bidang
Host Azure Databricks (String) URL host Azure Databricks untuk titik akhir ruang kerja Azure Databricks atau titik akhir akun Azure Databricks. DATABRICKS_HOST host host (Python),
setHost (Java),
Host (Go)
Token Azure Databricks (String) Token akses pribadi Azure Databricks atau token ID Microsoft Entra. DATABRICKS_TOKEN token token (Python),
setToken (Java),
Token (Go)
ID akun Azure Databricks (String) ID akun Azure Databricks untuk titik akhir akun Azure Databricks. Hanya berpengaruh ketika host Azure Databricks juga diatur ke
https://accounts.azuredatabricks.net.		 DATABRICKS_ACCOUNT_ID account_id account_id (Python),
setAccountID (Java),
AccountID (Go)

Variabel dan bidang lingkungan khusus Azure

Nama umum Deskripsi Variabel lingkungan .databrickscfg bidang, bidang Terraform Config bidang
ID klien Azure (String) ID aplikasi perwakilan layanan ID Microsoft Entra. Gunakan dengan autentikasi identitas terkelola Azure dan autentikasi perwakilan layanan MICROSOFT Entra ID. ARM_CLIENT_ID azure_client_id azure_client_id (Python),
setAzureClientID (Java),
AzureClientID (Go)
Rahasia klien Azure (String) Rahasia klien perwakilan layanan MICROSOFT Entra ID. Gunakan dengan autentikasi perwakilan layanan ID Microsoft Entra. ARM_CLIENT_SECRET azure_client_secret azure_client_secret (Python),
setAzureClientSecret (Java),
AzureClientSecret (Go)
ID klien (String) ID klien perwakilan layanan terkelola Azure Databricks atau perwakilan layanan terkelola ID Microsoft Entra. Gunakan dengan autentikasi M2M OAuth. DATABRICKS_CLIENT_ID client_id client_id (Python),
setClientId (Java),
ClientId (Go)
Rahasia Klien (String) Rahasia klien dari perwakilan layanan terkelola Azure Databricks atau perwakilan layanan terkelola ID Microsoft Entra. Gunakan dengan autentikasi M2M OAuth. DATABRICKS_CLIENT_SECRET client_secret client_secret (Python),
setClientSecret (Java),
ClientSecret (Go)
Lingkungan Azure (String) Jenis lingkungan Azure. Default ke PUBLIC. ARM_ENVIRONMENT azure_environment azure_environment (Python),
setAzureEnvironment (Java),
AzureEnvironment (Go)
ID penyewa Azure (String) ID penyewa perwakilan layanan MICROSOFT Entra ID. ARM_TENANT_ID azure_tenant_id azure_tenant_id (Python),
setAzureTenantID (Java),
AzureTenantID (Go)
Azure menggunakan MSI (Boolean) Benar untuk menggunakan alur autentikasi tanpa kata sandi Azure Managed Service Identity untuk perwakilan layanan. Mengharuskan ID sumber daya Azure juga diatur. ARM_USE_MSI azure_use_msi AzureUseMSI (Go)
ID sumber daya Azure (String) ID Azure Resource Manager untuk ruang kerja Azure Databricks. DATABRICKS_AZURE_RESOURCE_ID azure_workspace_resource_id azure_workspace_resource_id (Python),
setAzureResourceID (Java),
AzureResourceID (Go)

variabel dan bidang lingkungan khusus .databrickscfg

Gunakan variabel atau bidang lingkungan ini untuk menentukan pengaturan non-default untuk .databrickscfg. Lihat juga profil konfigurasi Azure Databricks.

Nama umum Deskripsi Variabel lingkungan Bidang Terraform Config bidang
.databrickscfg jalur file (String) Jalur non-default ke
.databrickscfg arsip.		 DATABRICKS_CONFIG_FILE config_file config_file (Python),
setConfigFile (Java),
ConfigFile (Go)
.databrickscfg profil default (String) Profil bernama default untuk digunakan, selain DEFAULT. DATABRICKS_CONFIG_PROFILE profile profile (Python),
setProfile (Java),
Profile (Go)

Bidang jenis autentikasi

Gunakan variabel atau bidang lingkungan ini untuk memaksa SDK menggunakan jenis autentikasi Databricks tertentu.

Nama umum Deskripsi Bidang Terraform Config bidang
Jenis autentikasi Databricks (String) Saat beberapa atribut autentikasi tersedia di lingkungan, gunakan jenis autentikasi yang ditentukan oleh argumen ini. auth_type auth_type (Python),
setAuthType (Java),
AuthType (Go)

Nilai bidang jenis autentikasi Databricks yang didukung meliputi: