Mengautentikasi dengan token akses pribadi Azure Databricks (warisan)

Token akses pribadi (PATs) Azure Databricks memungkinkan Anda mengautentikasi ke sumber daya dan API di tingkat ruang kerja. Anda dapat menyimpannya dalam variabel lingkungan atau profil konfigurasi Azure Databricks. Setiap PAT hanya berlaku untuk satu ruang kerja, dan pengguna dapat membuat hingga 600 PATs per ruang kerja. Azure Databricks secara otomatis mencabut PAT yang belum digunakan selama 90 hari.

Penting

Autentikasi nama pengguna dan kata sandi (tanpa token) mencapai akhir masa pakai pada 10 Juli 2024. Databricks sangat merekomendasikan penggunaan OAuth alih-alih PATs untuk autentikasi akun pengguna karena OAuth memberikan keamanan yang lebih kuat. Untuk mempelajari cara mengautentikasi dengan akun pengguna Databricks menggunakan OAuth, lihat Mengotorisasi akses pengguna ke Azure Databricks dengan OAuth.

Anda tidak dapat menggunakan token akses pribadi untuk mengotomatiskan fungsionalitas tingkat akun Azure Databricks. Sebagai gantinya, gunakan token ID Microsoft Entra yang dimiliki oleh admin akun Azure Databricks. Admin akun Azure Databricks dapat berupa pengguna atau prinsipal layanan. Untuk informasi selengkapnya, lihat:

• Mengelola pengguna
• Service Principal
• Kelompok

Membuat token akses pribadi untuk pengguna ruang kerja

Untuk membuat token akses pribadi untuk pengguna ruang kerja Azure Databricks Anda, lakukan hal berikut:

1. Di ruang kerja Azure Databricks Anda, klik nama pengguna Anda di bilah atas dan pilih Pengaturan.

2. Klik Pengembang.

3. Di samping Token akses, klik Kelola.

4. Klik Buat token baru.

5. Masukkan komentar yang membantu Anda mengidentifikasi token ini di masa mendatang.

6. Atur masa pakai token dalam hari. Lihat Mengatur masa pakai maksimum token akses pribadi baru.

7. Klik Hasilkan.

8. Salin token yang ditampilkan ke lokasi aman, lalu klik Selesai. Simpan token dengan aman dan jangan bagikan. Jika Anda kehilangannya, Anda harus membuat token baru.

Jika Anda tidak dapat membuat atau menggunakan token, administrator ruang kerja Anda mungkin telah menonaktifkan token atau tidak memberi Anda izin. Lihat administrator ruang kerja Anda atau berikut ini:

• Mengaktifkan atau menonaktifkan autentikasi token akses pribadi untuk ruang kerja
• Izin token akses pribadi

Membuat token akses pribadi untuk perwakilan layanan

Perwakilan layanan dapat membuat token akses pribadi untuk dirinya sendiri.

1. Jalankan perintah berikut untuk menghasilkan token akses:

   databricks tokens create --lifetime-seconds <lifetime-seconds> -p <profile-name>
   

   Ganti nilai berikut:

   • <lifetime-seconds>: Masa pakai token dalam detik, seperti 86400 selama 1 hari. Diatur ke maksimum ruang kerja (biasanya 730 hari).
   • <profile-name>: Profil konfigurasi dengan informasi autentikasi. Secara default menjadi DEFAULT.

2. Salin token_value dari respons, yang merupakan token akses untuk perwakilan layanan Anda. Simpan token dengan aman dan jangan bagikan. Jika Anda kehilangannya, Anda harus membuat token baru.

Jika Anda tidak dapat membuat atau menggunakan token, administrator ruang kerja Anda mungkin telah menonaktifkan token atau tidak memberi Anda izin. Lihat administrator ruang kerja Anda atau berikut ini:

• Mengaktifkan atau menonaktifkan autentikasi token akses pribadi untuk ruang kerja
• Izin token akses pribadi

Melakukan autentikasi token akses pribadi

Untuk mengonfigurasi autentikasi token akses pribadi Azure Databricks, atur variabel lingkungan, bidang, .databrickscfg bidang Terraform, atau Config bidang terkait berikut:

• Host Azure Databricks, ditentukan sebagai URL target Azure Databricks untuk setiap ruang kerja, misalnya https://adb-1234567890123456.7.azuredatabricks.net.
• Token akses pribadi Azure Databricks untuk akun pengguna Azure Databricks.

Untuk melakukan autentikasi token akses pribadi Azure Databricks, integrasikan hal berikut dalam kode Anda, berdasarkan alat atau SDK yang berpartisipasi:

Lingkungan

Untuk menggunakan variabel lingkungan untuk jenis autentikasi Azure Databricks tertentu dengan alat atau SDK, lihat Mengotorisasi akses ke sumber daya Azure Databricks atau dokumentasi alat atau SDK. Lihat juga Variabel dan bidang lingkungan untuk autentikasi terpadu dan prioritas metode Autentikasi.

Atur variabel lingkungan berikut:

• DATABRICKS_HOST, atur ke URL per ruang kerja Azure Databricks, misalnya https://adb-1234567890123456.7.azuredatabricks.net.
• DATABRICKS_TOKEN, diatur menjadi string token.

Profil

Buat atau identifikasi profil konfigurasi Azure Databricks yang memiliki bidang berikut di dalam file Anda .databrickscfg . Jika Anda membuat profil, ganti placeholder dengan nilai sesuai. Untuk menggunakan profil dengan alat atau SDK, lihat Mengotorisasi akses ke sumber daya Azure Databricks atau dokumentasi alat atau SDK. Lihat juga Variabel dan bidang lingkungan untuk autentikasi terpadu dan prioritas metode Autentikasi.

Atur nilai berikut dalam file .databrickscfg Anda. Dalam kasus ini, host-nya adalah URL per ruang kerja Azure Databricks, misalnya https://adb-1234567890123456.7.azuredatabricks.net:

[<some-unique-configuration-profile-name>]
host  = <workspace-url>
token = <token>

Alih-alih mengatur nilai secara manual, Anda dapat menggunakan Databricks CLI untuk mengatur nilai-nilai ini sebagai gantinya:

Catatan

Prosedur berikut menggunakan Databricks CLI untuk membuat profil konfigurasi Azure Databricks dengan nama DEFAULT. Jika Anda sudah memiliki profil konfigurasi DEFAULT, prosedur ini akan menimpa profil konfigurasi Anda yang ada DEFAULT.

Untuk memeriksa apakah Anda sudah memiliki DEFAULT profil konfigurasi, dan untuk melihat pengaturan profil ini jika ada, gunakan Databricks CLI untuk menjalankan perintah databricks auth env --profile DEFAULT.

Untuk membuat profil konfigurasi dengan nama selain DEFAULT, ganti DEFAULT bagian --profile DEFAULT dalam perintah berikut databricks configure dengan nama yang berbeda untuk profil konfigurasi.

1. Gunakan Databricks CLI untuk membuat profil konfigurasi Azure Databricks bernama DEFAULT yang menggunakan autentikasi token akses pribadi Azure Databricks. Untuk melakukannya, jalankan perintah berikut:

   databricks configure --profile DEFAULT
   

2. Untuk Permintaan Host Databricks, masukkan URL per ruang kerja Azure Databricks Anda, misalnya https://adb-1234567890123456.7.azuredatabricks.net.

3. Untuk perintah Token Akses Pribadi, masukkan token akses pribadi Azure Databricks untuk ruang kerja Anda.

antarmuka baris perintah (CLI)

Untuk Databricks CLI, jalankan databricks configure perintah . Pada perintah, masukkan pengaturan berikut:

• Host Azure Databricks, ditentukan sebagai URL target Azure Databricks untuk setiap ruang kerja, misalnya https://adb-1234567890123456.7.azuredatabricks.net.
• Token akses pribadi Azure Databricks untuk akun pengguna Azure Databricks.

Untuk informasi selengkapnya, lihat Autentikasi token akses pribadi (tidak digunakan lagi).

Sambungkan

Catatan

Autentikasi token akses pribadi Azure Databricks didukung pada versi Databricks Connect berikut:

• Untuk Python, Databricks Connect untuk Databricks Runtime 13.3 LTS dan versi yang lebih tinggi.
• Untuk Scala, Databricks Connect untuk Databricks Runtime 13.3 LTS dan versi yang lebih baru.

Untuk Databricks Connect, gunakan Databricks CLI untuk mengatur nilai dalam file Anda .databrickscfg , untuk operasi tingkat ruang kerja Azure Databricks seperti yang ditentukan di bagian Profil.

Prosedur berikut membuat profil konfigurasi Azure Databricks bernama DEFAULT, yang menimpa profil DEFAULT yang sudah ada. Untuk memeriksa apakah DEFAULT profil ada, jalankan databricks auth env --profile DEFAULT. Jika ada, gunakan nama profil yang berbeda.

1. Jalankan perintah berikut untuk membuat profil konfigurasi Azure Databricks bernama DEFAULT yang menggunakan autentikasi token akses pribadi.

   databricks configure --configure-cluster --profile DEFAULT
   

2. Untuk Permintaan Host Databricks, masukkan URL per ruang kerja Azure Databricks Anda, misalnya https://adb-1234567890123456.7.azuredatabricks.net.

3. Untuk perintah Token Akses Pribadi, masukkan token akses pribadi untuk ruang kerja Anda.

4. Dalam daftar kluster yang tersedia, pilih kluster Azure Databricks target di ruang kerja Anda. Anda dapat mengetik bagian mana pun dari nama tampilan kluster untuk memfilter daftar kluster yang tersedia.

Menggunakan REST API Azure Databricks untuk mengeluarkan token akses pribadi

Azure Databricks menyediakan endpoint REST /api/2.0/token/create untuk mengeluarkan PATs. Lihat Membuat token pengguna untuk detail API.

Dalam contoh berikut, atur nilai-nilai ini:

• <databricks-instance>: URL ruang kerja Databricks Anda. Contohnya,dbc-abcd1234-5678.cloud.databricks.com.
• <your-existing-access-token>: PAT (string) valid yang ada yang memiliki izin untuk membuat token baru.
• <lifetime-seconds>: Masa pakai token dalam hitung detik.

curl -X POST https://<databricks-instance>/api/2.0/token/create \
-H "Authorization: Bearer <your-existing-access-token>" \
-H "Content-Type: application/json" \
-d '{
  "lifetime_seconds": <lifetime-seconds>
}'

Jika berhasil, ini menghasilkan payload respons yang mirip dengan:

{
  "access_token": "<your-newly-issued-pat>",
  "token_type": "Bearer",
  "expires_in": <the-duration-of-the-new-pat>
}

Berikan token baru dari respons di header Otorisasi panggilan selanjutnya ke API REST Databricks. Contohnya:

# This example uses a simple GET. For POST or other REST verbs, you may need to provide additional parameters.
curl -X GET "https://<databricks-instance>/api/2.0/<path-to-endpoint>" \
     -H "Authorization: Bearer <your-new-pat>"

import requests

headers = {
    'Authorization': 'Bearer <your-new-pat>'
}
# This example is for an HTTP GET operation.
response = requests.get('https://<databricks-instance>/api/2.0/<path-to-endpoint>', headers=headers)