Profil konfigurasi Azure Databricks

Profil konfigurasi Azure Databricks menyimpan pengaturan autentikasi dalam .databrickscfg file. Profil konfigurasi memudahkan untuk beralih di antara berbagai ruang kerja, lingkungan, atau metode autentikasi tanpa mengubah kode Anda.

Alat, SDK, skrip, dan aplikasi dapat mereferensikan profil konfigurasi untuk diautentikasi dengan Azure Databricks. Semua alat dan SDK yang menerapkan autentikasi terpadu mendukung profil konfigurasi.

Apa itu profil konfigurasi?

Profil konfigurasi adalah bagian bernama dalam .databrickscfg file yang berisi yang berikut ini:

  • Kredensial autentikasi, seperti token atau kredensial perwakilan layanan
  • Ruang kerja atau URL akun Azure Databricks
  • Pengaturan opsional khusus untuk metode autentikasi Anda

Buat beberapa profil dalam satu .databrickscfg file untuk mengelola koneksi ke ruang kerja atau lingkungan yang berbeda seperti pengembangan, penahapan, dan produksi.

Membuat profil konfigurasi

Buat profil konfigurasi menggunakan Databricks CLI atau dengan mengedit .databrickscfg file secara manual.

Membuat profil dengan CLI

Cara term mudah untuk membuat profil konfigurasi untuk autentikasi pengguna interaktif adalah dengan Databricks CLI:

databricks auth login --host <workspace-url>

CLI membuka browser web Anda untuk menyelesaikan alur autentikasi. Setelah Anda masuk, CLI menyimpan kredensial sebagai profil konfigurasi.

Membuat profil secara manual

Untuk membuat profil konfigurasi secara manual:

  1. Buat file bernama .databrickscfg di direktori beranda Anda:

    • Unix, Linux, macOS:~/.databrickscfg
    • Windows:%USERPROFILE%\.databrickscfg

  2. Tambahkan profil dengan format berikut:

    [<profile-name>]
<field-name> = <field-value>

    Ganti tempat penampung:

    • <profile-name>: Nama unik seperti DEFAULT, DEVELOPMENT, atau PRODUCTION
    • <field-name> dan <field-value>: Bidang autentikasi untuk metode autentikasi Anda

Misalnya, untuk autentikasi mesin-ke-mesin (M2M) OAuth, .databrickscfg file terlihat seperti ini:

[DEFAULT]
host          = https://<workspace-url>
client_id     = <client-id>
client_secret = <client-secret>

Membuat beberapa profil

Tentukan beberapa profil dalam file yang sama .databrickscfg untuk mengelola ruang kerja atau lingkungan yang berbeda. Setiap profil harus memiliki nama yang unik.

[DEFAULT]
host          = https://production-workspace-url
client_id     = <production-client-id>
client_secret = <production-client-secret>

[DEVELOPMENT]
host          = https://dev-workspace-url
client_id     = <dev-client-id>
client_secret = <dev-client-secret>

[STAGING]
host          = https://staging-workspace-url
client_id     = <staging-client-id>
client_secret = <staging-client-secret>

Menggabungkan jenis autentikasi

Tentukan beberapa metode autentikasi di profil terpisah dalam file konfigurasi Anda. Ini berguna ketika Anda ingin menggunakan kredensial yang berbeda untuk alur kerja atau alat yang berbeda. Misalnya, Anda dapat menggunakan autentikasi cloud-native untuk penggunaan interaktif dan kredensial OAuth untuk otomatisasi:

[DEFAULT]
host = https://<workspace-url>

[SERVICE_PRINCIPAL]
azure_workspace_resource_id = /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.Databricks/workspaces/<workspace-name>
azure_tenant_id             = <tenant-id>
azure_client_id             = <client-id>
azure_client_secret         = <client-secret>

Untuk informasi selengkapnya tentang jenis autentikasi dan bidang yang diperlukan, lihat Autentikasi terpadu Databricks.

Menggunakan profil konfigurasi

Setelah Anda membuat profil konfigurasi, referensikan di alat dan kode Anda. Jika Anda tidak menentukan nama profil, alat Azure Databricks dan SDK secara otomatis menggunakan profil tersebut DEFAULT .

Untuk menggunakan profil selain DEFAULT, tentukan nama profil:

Dengan Databricks CLI:

databricks workspace list --profile DEVELOPMENT

Dengan variabel lingkungan:

export DATABRICKS_CONFIG_PROFILE=DEVELOPMENT
databricks workspace list

Dengan Python SDK:

from databricks.sdk import WorkspaceClient

# Specify profile in code
w = WorkspaceClient(profile="DEVELOPMENT")

# Or use environment variable DATABRICKS_CONFIG_PROFILE

Praktik terbaik

  • Gunakan profil DEFAULT untuk ruang kerja Anda yang paling umum untuk meminimalkan kebutuhan untuk menentukan nama profil.
  • Gunakan nama profil deskriptif seperti PRODUCTION, , DEVELOPMENTatau STAGING alih-alih nama generik.
  • Lindungi file Anda .databrickscfg dengan mengatur izin file terbatas (hanya dapat dibaca oleh pengguna Anda).
  • Jangan mengunggah .databrickscfg ke dalam kontrol versi. Tambahkan itu ke dalam file Anda .gitignore.
  • Gunakan prinsipal layanan untuk beban kerja produksi alih-alih token akses pribadi.
  • Ganti kredensial secara teratur dan perbarui profil Anda dengan sewajarnya.

Troubleshooting

Jika profil tidak dapat ditemukan, verifikasi hal berikut:

  • File .databrickscfg berada di direktori beranda Anda.
  • Anda menggunakan nama profil yang tepat.
  • File tidak diberi nama .databrickscfg.txt atau sesuatu yang serupa.

Jika autentikasi gagal, verifikasi hal berikut:

  • Kredensial Anda masih berlaku dan belum kedaluwarsa.
  • host URL sudah benar.
  • Anda memiliki izin yang diperlukan untuk operasi yang Anda coba.

Uji profil konfigurasi Anda menggunakan Databricks CLI:

# Inspect a specific profile
databricks auth env --profile DEVELOPMENT

# List all profiles
databricks auth profiles

Untuk informasi selengkapnya, lihat Menguji profil konfigurasi Anda.

Pelajari lebih lanjut

  • Last updated on