Bagikan melalui

auth grup perintah

  • Artikel

Catatan

Informasi ini berlaku untuk Databricks CLI versi 0.205 ke atas. Databricks CLI ada di Pratinjau Umum.

Penggunaan Databricks CLI tunduk pada Lisensi Databricks dan Pemberitahuan Privasi Databricks, termasuk ketentuan Data Penggunaan apa pun.

auth Grup perintah dalam Databricks CLI memungkinkan Anda untuk:

  • Mencantumkan profil konfigurasi autentikasi yang tersedia.
  • Dapatkan informasi tentang profil konfigurasi autentikasi individual.
  • Gunakan autentikasi pengguna-ke-mesin (U2M) OAuth untuk mengautentikasi Databricks CLI dengan akun dan ruang kerja Azure Databricks Anda.
  • Dapatkan informasi tentang token akses OAuth apa pun yang mungkin telah di-cache oleh Databricks CLI.
  • Dapatkan detail tentang konfigurasi yang digunakan Databricks CLI untuk mengautentikasi.

Anda menjalankan auth perintah dengan menambahkannya ke databricks auth. Untuk menampilkan bantuan untuk perintah, jalankan authdatabricks auth -h.

Mencantumkan profil konfigurasi

Untuk mendapatkan daftar semua profil konfigurasi yang tersedia dan untuk memeriksa apakah profil tersebut valid, jalankan perintah auth profiles, sebagai berikut:

databricks auth profiles

Output (elipsis mewakili konten yang dihilangkan, untuk brevity):

Name            Host                Valid
DEFAULT         https://<host-url>  YES
<profile-name>  https://<host-url>  NO

Untuk menentukan apakah setiap profil valid, Databricks CLI menjalankan perintah daftar ruang kerja untuk setiap profil di tingkat akun dan menjalankan perintah pengguna saat ini untuk setiap profil di tingkat ruang kerja. Jika perintah berhasil, akan YES ditampilkan; jika tidak, perintah NO akan ditampilkan.

Output perintah auth profiles tidak menampilkan token akses apa pun. Untuk menampilkan token akses, lihat Mendapatkan informasi tentang profil konfigurasi.

Profil konfigurasi disimpan dalam file ~/.databrickscfg di Linux atau macOS, atau %USERPROFILE%\.databrickscfg di Windows secara default. Anda dapat mengubah jalur default file ini dengan mengatur variabel DATABRICKS_CONFIG_FILElingkungan . Untuk mempelajari cara mengatur variabel lingkungan, lihat dokumentasi sistem operasi Anda.

Untuk membuat profil konfigurasi, lihat grup perintah konfigurasi.

Dapatkan informasi tentang profil konfigurasi

Untuk mendapatkan informasi tentang profil konfigurasi yang ada, jalankan perintah auth env, di mana <profile-name> mewakili nama profil, dan <account-or-workspace-url> mewakili URL konsol akun Azure Databricks atau URL ruang kerja Azure Databricks, sebagai berikut:

databricks auth env --profile <profile-name>

# Or:
databricks auth env --host <account-or-workspace-url>

Tip

Anda dapat menekan Tab setelah --profile atau -p untuk menampilkan daftar profil konfigurasi yang tersedia untuk dipilih, alih-alih memasukkan nama profil konfigurasi secara manual.

Misalnya, berikut adalah output untuk profil yang dikonfigurasi dengan autentikasi token akses Azure Databricks:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "<profile-name>",
    "DATABRICKS_HOST": "<workspace-url>",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

Catatan

Jika lebih dari satu profil cocok dengan --host nilai, kesalahan akan ditampilkan, yang menyatakan bahwa profil tidak dapat menemukan satu profil yang cocok. Misalnya, Anda mungkin memiliki satu profil yang hanya memiliki nilai host dan profil lain yang memiliki nilai host yang sama tetapi juga nilai token. Dalam hal ini, Databricks CLI tidak memilih profil dan berhenti. Untuk membantu Databricks CLI memilih profil yang diinginkan, coba tentukan nilai yang berbeda --host . Untuk nilai --host yang merupakan URL konsol akun, coba tentukan nilai --account-id alih-alih nilai --host.

Untuk membuat profil konfigurasi, lihat grup perintah konfigurasi.

Mengautentikasi dengan OAuth

Alih-alih mengautentikasi dengan Azure Databricks dengan menggunakan token akses dan profil konfigurasi, Anda dapat menggunakan autentikasi pengguna-ke-mesin (U2M) OAuth. OAuth menyediakan token dengan waktu kedaluwarsa yang lebih cepat daripada token akses pribadi Azure Databricks, dan menawarkan pembatalan dan cakupan sesi sisi server yang lebih baik. Karena token akses OAuth kedaluwarsa dalam waktu kurang dari satu jam, ini mengurangi risiko yang terkait dengan pemeriksaan token secara tidak sengaja ke kontrol sumber. Lihat Mengotorisasi akses interaktif ke sumber daya Azure Databricks dengan akun pengguna menggunakan OAuth.

Untuk mengonfigurasi dan menyiapkan autentikasi OAuth U2M, lihat autentikasi OAuth user-to-machine (U2M).

Mendapatkan detail token akses OAuth

Jika Anda ingin melihat informasi tentang token akses OAuth yang di-cache yang sebelumnya dihasilkan CLI Databricks untuk ruang kerja Azure Databricks, jalankan perintah auth token, di mana <workspace-url> mewakili URL ruang kerja Azure Databricks, sebagai berikut:

databricks auth token <workspace-url>

Output:

{
  "access_token": "<token-value>",
  "token_type": "Bearer",
  "expiry": "<token-expiration-date-time>"
}

Mendapatkan detail autentikasi

Untuk mendapatkan detail tentang konfigurasi yang digunakan Databricks CLI untuk mengautentikasi, jalankan perintah auth describe.

Jika tidak ada opsi yang ditentukan, auth describe perintah mengikuti metode Default untuk autentikasi terpadu klien.

databricks auth describe

Output:

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: default
  ✓ auth_type: <authentication-type> (from <path>/<to>/.databrickscfg config file)

Untuk menentukan informasi tersebut tentang ruang kerja Azure Databricks tertentu yang digunakan, tentukan --host opsi bersama dengan URL ruang kerja.

databricks auth describe --host https://<workspace-instance-name>

Output:

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from --host flag)
  ✓ profile: default
  ✓ auth_type: <authentication-type>

Untuk menentukan informasi tersebut tentang akun Azure Databricks tertentu yang digunakan, tentukan --host opsi bersama dengan URL konsol akun Azure Databricks, https://accounts.azuredatabricks.net.

databricks auth describe --host <account-console-url>

Output:

Host: <account-console-url>
User: <user-name>@<domain>
AccountId: <account-id>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: <account-console-url> (from --host flag)
  ✓ account_id: <account-id>
  ✓ profile: default
  ✓ auth_type: <authentication-type>

Untuk menentukan informasi tentang profil konfigurasi Azure Databricks tertentu digunakan, tentukan -p opsi atau --profile bersama dengan nama profil.

databricks auth describe -p <profile-name>

Output:

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: ******** (from <path>/<to>/.databrickscfg config file)
  ✓ profile: <profile-name> (from --profile flag)
  ✓ auth_type: <authentication-type>

Untuk menyertakan informasi sensitif dalam output (seperti token akses pribadi Azure Databricks dan rahasia klien), tentukan --sensitive opsi .

databricks auth describe --sensitive

Output:

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: pat
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: <token-value> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: <profile-name>
  ✓ auth_type: pat