Autentikasi token akses pribadi Azure Databricks

Token akses pribadi (PATs) Azure Databricks digunakan untuk mengautentikasi akses ke sumber daya dan API di tingkat ruang kerja Azure Databricks. Banyak mekanisme penyimpanan untuk kredensial dan informasi terkait, seperti variabel lingkungan dan profil konfigurasi Azure Databricks, memberikan dukungan untuk token akses pribadi Azure Databricks. Meskipun pengguna dapat memiliki beberapa token akses pribadi di ruang kerja Azure Databricks, setiap token akses pribadi hanya berfungsi untuk satu ruang kerja Azure Databricks. Jumlah token akses pribadi untuk setiap pengguna dibatasi hingga 600 per ruang kerja.

Databricks secara otomatis mencabut token akses pribadi yang belum digunakan dalam 90 hari atau lebih.

Penting

Databricks merekomendasikan penggunaan OAuth alih-alih PATs untuk autentikasi dan otorisasi klien akun pengguna karena peningkatan keamanan yang dimiliki OAuth. Untuk mempelajari cara menggunakan OAuth untuk melakukan autentikasi klien dengan akun pengguna Databricks, lihat Mengautentikasi akses ke Azure Databricks dengan akun pengguna menggunakan OAuth (OAuth U2M) (untuk autentikasi akun pengguna).

Autentikasi dasar (bukan berbasis token) menggunakan nama pengguna dan kata sandi Azure Databricks mencapai akhir masa pakai pada 10 Juli 2024.

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

• Mengelola pengguna

  • Mengelola perwakilan layanan
  • Kelola grup

  Lihat juga:

  • Autentikasi identitas terkelola Azure
  • Autentikasi perwakilan layanan MS Entra
  • Autentikasi Azure CLI

Token akses pribadi Azure Databricks untuk pengguna ruang kerja

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

1. Di ruang kerja Azure Databricks Anda, klik nama pengguna Azure Databricks Anda di bilah atas, lalu pilih Pengaturan dari menu drop-down.
2. Klik Pengembang.
3. Di samping Token akses, klik Kelola.
4. Klik Buat token baru.
5. (Opsional) Masukkan komentar yang membantu Anda mengidentifikasi token ini di masa mendatang, dan mengubah masa pakai default token selama 90 hari. Untuk membuat token tanpa masa pakai (tidak disarankan), biarkan kotak Seumur Hidup (hari) kosong (kosong).
6. Klik Buat.
7. Salin token yang ditampilkan ke lokasi aman, lalu klik Selesai.

Catatan

Pastikan untuk menyimpan token yang disalin di lokasi yang aman. Jangan bagikan token yang Anda salin dengan orang lain. Jika Anda kehilangan token yang disalin, Anda tidak dapat meregenerasi token yang sama persis. Sebagai gantinya, Anda harus mengulangi prosedur ini untuk membuat token baru. Jika Anda kehilangan token yang disalin, atau Anda yakin bahwa token telah disusupi, Databricks sangat menyarankan agar Anda segera menghapus token tersebut dari ruang kerja Anda dengan mengklik ikon tempat sampah (Cabut) di samping token di halaman Token akses.

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

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

Token akses pribadi Azure Databricks untuk perwakilan layanan

Perwakilan layanan dapat membuat token akses pribadi Databricks untuk dirinya sendiri, sebagai berikut:

Prosedur ini mengasumsikan bahwa Anda menggunakan autentikasi mesin-ke-mesin (M2M) OAuth atau autentikasi perwakilan layanan Microsoft Entra ID untuk menyiapkan Databricks CLI untuk mengautentikasi perwakilan layanan guna menghasilkan token akses pribadi Azure Databricks untuk dirinya sendiri. Lihat autentikasi mesin-ke-mesin (M2M) OAuth atau autentikasi perwakilan layanan MICROSOFT Entra ID.

1. Gunakan Databricks CLI untuk menjalankan perintah berikut, yang menghasilkan token akses lain untuk perwakilan layanan.

   Jalankan perintah berikut:

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

   • --comment: Ganti <comment> dengan komentar yang bermakna tentang tujuan token akses. --comment Jika opsi tidak ditentukan, maka tidak ada komentar yang dihasilkan.
   • --lifetime-seconds: Ganti <lifetime-seconds> dengan jumlah detik yang berlaku untuk token akses. Misalnya, 1 hari adalah 86400 detik. --lifetime-seconds Jika opsi tidak ditentukan, token akses diatur ke tidak pernah kedaluwarsa (tidak disarankan).
   • --profile-name: Ganti <profile-name> dengan nama profil konfigurasi Azure Databricks yang berisi informasi autentikasi untuk perwakilan layanan dan ruang kerja target. -p Jika opsi tidak ditentukan, Databricks CLI akan mencoba menemukan dan menggunakan profil konfigurasi bernama DEFAULT.

2. Dalam respons, salin nilai token_value, yang merupakan token akses untuk perwakilan layanan.

   Pastikan untuk menyimpan token yang disalin di lokasi yang aman. Jangan bagikan token yang Anda salin dengan orang lain. Jika Anda kehilangan token yang disalin, Anda tidak dapat meregenerasi token yang sama persis. Sebagai gantinya, Anda harus mengulangi prosedur ini untuk membuat token baru.

   Jika Anda tidak dapat membuat atau menggunakan token di ruang kerja, ini mungkin karena administrator ruang kerja Anda telah menonaktifkan token atau belum memberi Anda izin untuk membuat atau menggunakan token. 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 Azure Databricks

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

• Host Azure Databricks, ditentukan sebagai URL target Azure Databricks per 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 Mengautentikasi akses ke sumber daya Azure Databricks atau dokumentasi alat atau SDK. Lihat juga Variabel dan bidang lingkungan untuk autentikasi terpadu klien dan metode Default untuk autentikasi terpadu klien.

Atur variabel lingkungan berikut:

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

Profil

Buat atau identifikasi profil konfigurasi Azure Databricks dengan bidang berikut dalam file Anda.databrickscfg. Jika Anda membuat profil, ganti tempat penampung dengan nilai yang sesuai. Untuk menggunakan profil dengan alat atau SDK, lihat Mengautentikasi akses ke sumber daya Azure Databricks atau dokumentasi alat atau SDK. Lihat juga Variabel dan bidang lingkungan untuk autentikasi terpadu klien dan metode Default untuk autentikasi terpadu klien.

Atur nilai berikut dalam file Anda .databrickscfg . Dalam hal ini, host 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 sebelumnya secara manual dalam file Anda .databrickscfg , Anda dapat menggunakan Databricks CLI untuk mengatur nilai-nilai ini sebagai gantinya, sebagai berikut:

Catatan

Prosedur berikut menggunakan Databricks CLI untuk membuat profil konfigurasi Azure Databricks dengan nama DEFAULT. Jika Anda sudah memiliki DEFAULT profil konfigurasi, prosedur ini akan menimpa profil konfigurasi 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.

CLI

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

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

Untuk detail selengkapnya, lihat Autentikasi token akses pribadi Azure Databricks.

Sambungkan

Catatan

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

• Untuk Python, Databricks Connect untuk Databricks Runtime 13.3 LTS ke atas.
• Untuk Scala, Databricks Connect untuk Databricks Runtime 13.3 LTS ke atas.

Untuk Databricks Connect, Anda dapat menggunakan Databricks CLI untuk mengatur nilai dalam file Anda.databrickscfg, untuk operasi tingkat ruang kerja Azure Databricks seperti yang ditentukan di bagian "Profil" artikel ini, sebagai berikut:

Catatan

Prosedur berikut menggunakan Databricks CLI untuk membuat profil konfigurasi Azure Databricks dengan nama DEFAULT. Jika Anda sudah memiliki DEFAULT profil konfigurasi, prosedur ini akan menimpa profil konfigurasi 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 databricks configure perintah seperti yang ditunjukkan pada langkah berikut 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 --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 Azure Databricks untuk ruang kerja Anda.

4. Dalam daftar kluster yang tersedia yang muncul, gunakan tombol panah atas dan panah bawah untuk memilih kluster Azure Databricks target di ruang kerja Anda, lalu tekan Enter. Anda juga dapat mengetik bagian mana pun dari nama tampilan kluster untuk memfilter daftar kluster yang tersedia.

Pendekatan lain yang didukung untuk Databricks Connect meliputi yang berikut ini:

• Atur nilai secara manual dalam file Anda .databrickscfg untuk operasi tingkat ruang kerja Azure Databricks seperti yang ditentukan di bagian "Profil" artikel ini. Atur cluster_id juga variabel lingkungan di profil Anda ke URL per ruang kerja Anda, misalnya https://adb-1234567890123456.7.azuredatabricks.net.
• Atur variabel lingkungan untuk operasi tingkat ruang kerja Azure Databricks seperti yang ditentukan di bagian "Lingkungan" artikel ini. Atur DATABRICKS_CLUSTER_ID juga variabel lingkungan ke URL per ruang kerja Anda, misalnya https://adb-1234567890123456.7.azuredatabricks.net.

Nilai dalam file Anda .databrickscfg selalu diutamakan daripada variabel lingkungan.

Untuk menginisialisasi klien Databricks Connect dengan variabel atau nilai lingkungan ini dalam file Anda .databrickscfg , lihat salah satu hal berikut ini:

• Untuk Python, lihat Mengonfigurasi properti koneksi untuk Python.
• Untuk Scala, lihat Mengonfigurasi properti koneksi untuk Scala.

Kode VS

Untuk ekstensi Databricks untuk Visual Studio Code, lakukan hal berikut:

1. Atur nilai dalam file Anda .databrickscfg untuk operasi tingkat ruang kerja Azure Databricks seperti yang ditentukan di bagian "Profil" artikel ini.
2. Di panel Konfigurasi ekstensi Databricks untuk Visual Studio Code, klik Konfigurasikan Databricks.
3. Di Palet Perintah, untuk Host Databricks, masukkan URL per ruang kerja Anda, misalnya https://adb-1234567890123456.7.azuredatabricks.net, lalu tekan Enter.
4. Di Palet Perintah, pilih nama profil target Anda dalam daftar untuk URL Anda.

Untuk detail selengkapnya, lihat Penyiapan autentikasi untuk ekstensi Databricks untuk Visual Studio Code.

Terraform

Untuk autentikasi default:

provider "databricks" {
  alias = "workspace"
}

Untuk konfigurasi langsung (ganti retrieve tempat penampung dengan implementasi Anda sendiri untuk mengambil nilai dari konsol atau beberapa penyimpanan konfigurasi lainnya, seperti HashiCorp Vault. Lihat juga Penyedia Vault). Dalam hal ini, host adalah URL per ruang kerja Azure Databricks, misalnya https://adb-1234567890123456.7.azuredatabricks.net:

provider "databricks" {
  alias = "workspace"
  host  = <retrieve-workspace-url>
  token = <retrieve-token>
}

Untuk informasi selengkapnya tentang mengautentikasi dengan penyedia Databricks Terraform, lihat Autentikasi.

Python

Untuk autentikasi default:

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()
# ...

Untuk konfigurasi langsung (ganti retrieve tempat penampung dengan implementasi Anda sendiri untuk mengambil nilai dari konsol atau beberapa penyimpanan konfigurasi lainnya, seperti Azure KeyVault). Dalam hal ini, host adalah URL per ruang kerja Azure Databricks, misalnya https://adb-1234567890123456.7.azuredatabricks.net:

from databricks.sdk import WorkspaceClient

w = WorkspaceClient(
  host  = retrieve_workspace_url(),
  token = retrieve_token()
)
# ...

Untuk informasi selengkapnya tentang mengautentikasi dengan alat databricks dan SDK yang menggunakan Python dan yang mengimplementasikan autentikasi terpadu klien Databricks, lihat:

• Menyiapkan klien Databricks Connect untuk Python
• Penyiapan autentikasi untuk ekstensi Databricks untuk Visual Studio Code
• Mengautentikasi SDK Databricks untuk Python dengan akun atau ruang kerja Azure Databricks Anda

Java

Untuk autentikasi default:

import com.databricks.sdk.WorkspaceClient;
// ...
WorkspaceClient w = new WorkspaceClient();
// ...

Untuk konfigurasi langsung (ganti retrieve tempat penampung dengan implementasi Anda sendiri untuk mengambil nilai dari konsol atau beberapa penyimpanan konfigurasi lainnya, seperti Azure KeyVault). Dalam hal ini, host adalah URL per ruang kerja Azure Databricks, misalnya https://adb-1234567890123456.7.azuredatabricks.net:

import com.databricks.sdk.WorkspaceClient;
import com.databricks.sdk.core.DatabricksConfig;
// ...
DatabricksConfig cfg = new DatabricksConfig()
  .setHost(retrieveWorkspaceUrl())
  .setToken(retrieveToken());
WorkspaceClient w = new WorkspaceClient(cfg);
// ...

Untuk informasi selengkapnya tentang mengautentikasi dengan alat databricks dan SDK yang menggunakan Java dan yang menerapkan autentikasi terpadu klien Databricks, lihat:

• Siapkan klien Databricks Connect untuk Scala (klien Databricks Connect untuk Scala menggunakan Databricks SDK untuk Java yang disertakan untuk autentikasi)
• Mengautentikasi Databricks SDK for Java dengan akun atau ruang kerja Azure Databricks Anda

Go

Untuk autentikasi default:

import (
  "github.com/databricks/databricks-sdk-go"
)
// ...
w := databricks.Must(databricks.NewWorkspaceClient())
// ...

Untuk konfigurasi langsung (ganti retrieve tempat penampung dengan implementasi Anda sendiri untuk mengambil nilai dari konsol atau beberapa penyimpanan konfigurasi lainnya, seperti Azure KeyVault). Dalam hal ini, host adalah URL per ruang kerja Azure Databricks, misalnya https://adb-1234567890123456.7.azuredatabricks.net:

import (
  "github.com/databricks/databricks-sdk-go"
)
// ...
w := databricks.Must(databricks.NewWorkspaceClient(&databricks.Config{
  Host:  retrieveWorkspaceUrl(),
  Token: retrieveToken(),
}))
// ...

Untuk informasi selengkapnya tentang mengautentikasi dengan alat databricks dan SDK yang menggunakan Go dan yang mengimplementasikan autentikasi terpadu klien Databricks, lihat Mengautentikasi Databricks SDK for Go dengan akun atau ruang kerja Azure Databricks Anda.