Bagikan melalui

grup perintah auth

Note

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

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

auth Grup perintah dalam Databricks CLI berisi perintah terkait autentikasi, termasuk yang berikut ini:

  • 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.

Tip

Untuk mendapatkan informasi tentang pengguna Databricks CLI saat ini, jalankan databricks current-user me.

autentikasi databricks menjelaskan

Menjelaskan konfigurasi yang digunakan Databricks CLI untuk mengautentikasi, termasuk kredensial dan sumber kredensial tersebut. Jika tidak ada opsi yang ditentukan, auth describe perintah mengikuti prioritas metode Autentikasi.

databricks auth describe [flags]

Opsi

--sensitive

    Sertakan bidang sensitif seperti kata sandi dan token dalam output

Bendera global

Contoh

Contoh berikut menjelaskan konfigurasi autentikasi saat ini:

databricks auth describe

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 menggunakan informasi tentang ruang kerja Azure Databricks tertentu, gunakan opsi --host bersama dengan URL ruang kerja tersebut.

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

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>

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 TEST

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: TEST (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

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

databricks auth env

Dapatkan informasi tentang profil konfigurasi yang ada menggunakan nama profil atau URL konsol akun Azure Databricks atau URL ruang kerja Azure Databricks.

databricks auth env [flags]

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.

Untuk membuat profil konfigurasi, lihat configure perintah .

Opsi

--host string

    Nama host untuk mendapatkan env auth untuk

Note

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.

--profile string

    Profil untuk mendapatkan env autentikasi untuk

Bendera global

Contoh

Contoh berikut mendapatkan lingkungan autentikasi default:

databricks auth env

Contoh berikut mendapatkan lingkungan autentikasi untuk host tertentu:

databricks auth env --host https://my-workspace.cloud.databricks.com

Output untuk profil yang dikonfigurasi dengan autentikasi token akses Azure Databricks mungkin:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "TEST",
    "DATABRICKS_HOST": "https://my-workspace.cloud.databricks.com",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

Contoh berikut mendapatkan lingkungan autentikasi untuk profil tertentu:

databricks auth env --profile my-test-environment

databricks autentikasi masuk

Masuk ke ruang kerja atau akun Databricks dan simpan konfigurasi autentikasi di profil (secara ~/.databrickscfg default). Profil kemudian dapat digunakan untuk mengautentikasi perintah Databricks CLI lainnya menggunakan --profile bendera . Profil ini juga dapat digunakan untuk mengautentikasi alat Databricks lain yang mendukung autentikasi terpadu Databricks, termasuk Databricks Python, Java, dan Go SDK.

databricks auth login HOST [flags]

Perintah ini memerlukan URL host Databricks (menggunakan --host atau sebagai argumen posisional atau secara implisit disimpulkan dari nama profil yang ditentukan) dan nama profil (menggunakan --profile) untuk ditentukan. Jika Anda tidak menentukan nilai-nilai ini, Anda akan dimintai nilai saat runtime.

Meskipun perintah ini selalu memasukkan Anda ke host yang ditentukan, perilaku tergantung pada profil yang ada yang telah Anda tetapkan dalam file konfigurasi Anda (secara ~/.databrickscfg default):

  1. Jika profil dengan nama yang ditentukan ada dan menentukan host, Anda akan masuk ke host yang ditentukan oleh profil. Profil akan diperbarui untuk menggunakan "databricks-cli" sebagai jenis autentikasi jika itu tidak terjadi sebelumnya.
  2. Jika profil dengan nama yang ditentukan ada tetapi tidak menentukan host, Anda akan diminta untuk menentukan host. Profil akan diperbarui untuk menggunakan host yang ditentukan. Jenis autentikasi akan diperbarui ke "databricks-cli" jika itu tidak terjadi sebelumnya.
  3. Jika profil dengan nama yang ditentukan ada dan menentukan host, tetapi Anda menentukan host menggunakan --host (atau sebagai HOST arg posisional), profil akan diperbarui untuk menggunakan host yang baru ditentukan. Jenis autentikasi akan diperbarui ke "databricks-cli" jika itu tidak terjadi sebelumnya.
  4. Jika profil dengan nama yang ditentukan tidak ada, profil baru akan dibuat dengan host yang ditentukan. Jenis autentikasi akan diatur ke "databricks-cli".

Argumen

HOST

    URL host Databricks (opsional)

Opsi

--configure-cluster

    Perintah untuk mengonfigurasi kluster (komputasi klasik)

--configure-serverless

    Perintah untuk mengonfigurasi komputasi tanpa server

--timeout duration

    Batas waktu untuk menyelesaikan tantangan masuk di browser (default 1h0m0s)

Bendera global

Contoh

Contoh berikut masuk ke ruang kerja Databricks:

databricks auth login

Contoh berikut masuk ke ruang kerja Databricks tertentu:

databricks auth login https://my-workspace.cloud.databricks.com

Contoh berikut masuk dengan profil tertentu dan mengonfigurasi pengaturan kluster:

databricks auth login --profile my-profile --configure-cluster

Contoh berikut menetapkan batas waktu kustom untuk proses masuk:

databricks auth login --timeout 30m

profil autentikasi databricks

Cantumkan semua profil konfigurasi yang tersedia (secara ~/.databrickscfg default) dan periksa apakah profil tersebut adalah profil yang valid.

databricks auth profiles [flags]

Perintah ini menghasilkan profil dalam format berikut:

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

Untuk menentukan apakah setiap profil valid, Databricks CLI mencantumkan ruang kerja untuk setiap profil tingkat akun dan menjalankan perintah dapatkan pengguna saat ini untuk setiap profil 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 env autentikasi databricks.

Secara default, profil konfigurasi disimpan dalam file ~/.databrickscfg di Linux atau macOS, atau %USERPROFILE%\.databrickscfg di Windows. Anda dapat mengubah jalur default file ini dengan mengatur variabel DATABRICKS_CONFIG_FILElingkungan .

Untuk membuat profil konfigurasi, lihat configure perintah .

Opsi

--skip-validate

    Apakah akan melewati validasi profil

Bendera global

Contoh

Contoh berikut mencantumkan semua profil autentikasi:

databricks auth profiles

Contoh berikut mencantumkan profil tanpa memvalidasinya:

databricks auth profiles --skip-validate

token autentikasi databricks

Dapatkan token autentikasi dari cache lokal di ~/.databricks/token-cache.json. Refresh token akses jika kedaluwarsa. Perintah ini hanya berfungsi dengan autentikasi U2M (menggunakan databricks auth login perintah ). Autentikasi M2M menggunakan ID klien dan rahasia tidak didukung.

databricks auth token [HOST] [flags]

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

Argumen

HOST

    URL Host Databricks (opsional)

Opsi

--account-id string

    ID Akun Databricks

--timeout duration

    Waktu habis untuk memperoleh token. (bawaan 1h0m0s)

Bendera global

Contoh

Contoh berikut mendapatkan token autentikasi:

databricks auth token

Contoh berikut mendapatkan token autentikasi untuk host tertentu:

databricks auth token https://my-workspace.cloud.databricks.com

Outputnya mungkin:

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

Contoh berikut menetapkan batas waktu kustom untuk akuisisi token:

databricks auth token --timeout 30m

Bendera dunia

--debug

  Apakah debug logging ingin diaktifkan?

-h atau --help

    Tampilkan bantuan untuk Databricks CLI atau grup perintah terkait atau perintah terkait.

--log-file tali

    String yang mewakili file yang akan digunakan untuk menulis log output. Jika bendera ini tidak ditentukan, maka defaultnya adalah menulis log output ke stderr.

--log-format format

    Jenis format log, text atau json. Nilai defaultnya adalah text.

--log-level tali

    Untaian yang menggambarkan tingkat format log. Jika tidak ditentukan, maka tingkat format log akan dinonaktifkan.

-o, --output jenis

    Jenis output perintah, text atau json. Nilai defaultnya adalah text.

-p, --profile tali

    Nama profil dalam file ~/.databrickscfg yang digunakan untuk menjalankan perintah. Jika bendera ini tidak ditentukan maka jika ada, profil bernama DEFAULT digunakan.

--progress-format format

    Format untuk menampilkan log kemajuan: default, , append, inplaceatau json

-t, --target tali

    Jika berlaku, target bundel yang akan digunakan

  • Last updated on