Bagikan melalui


grup perintah secrets

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.

secrets Grup perintah dalam Databricks CLI memungkinkan Anda mengelola rahasia, cakupan rahasia, dan izin akses. Terkadang mengakses data mengharuskan Anda mengautentikasi ke sumber data eksternal melalui JDBC. Alih-alih langsung memasukkan kredensial Anda ke dalam buku catatan, gunakan rahasia Databricks untuk menyimpan kredensial Anda dan mereferensikannya di buku catatan dan pekerjaan. Lihat Manajemen Rahasia.

databricks secrets create-scope

Buat cakupan rahasia baru.

Nama cakupan harus terdiri dari karakter alfanumerik, tanda hubung, garis bawah, dan titik, dan tidak boleh melebihi 128 karakter.

databricks secrets create-scope SCOPE [flags]

Arguments

SCOPE

    Nama cakupan yang diminta oleh pengguna. Nama cakupan bersifat unik.

Opsi

--initial-manage-principal string

    Entitas yang diberi izin KELOLA awalnya pada cakupan yang dibuat.

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

--scope-backend-type ScopeBackendType

    Jenis backend yang akan digunakan untuk membuat cakupan. Nilai yang didukung: AZURE_KEYVAULT, DATABRICKS

Bendera global

Perintah untuk menghapus ACL (Access Control List) pada rahasia Databricks

Hapus ACL yang sudah ditentukan pada cakupan yang dimaksud.

Pengguna harus memiliki MANAGE izin untuk memanggil perintah ini. Melemparkan pengecualian RESOURCE_DOES_NOT_EXIST jika tidak ada cakupan rahasia, prinsipal, atau ACL yang bersangkutan. PERMISSION_DENIED Akan melemparkan kesalahan jika pengguna tidak memiliki izin untuk melakukan panggilan API ini.

databricks secrets delete-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Nama cakupan yang izinnya akan dihapus.

PRINCIPAL

    Prinsipal untuk menghapus ACL yang ada.

Opsi

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

Bendera global

databricks secrets delete-scope (perintah ini digunakan untuk menghapus scope dari secrets di platform Databricks)

Menghapus ruang lingkup rahasia.

Melemparkan RESOURCE_DOES_NOT_EXIST jika cakupan tidak ada. PERMISSION_DENIED Melemparkan jika pengguna tidak memiliki izin untuk melakukan panggilan ini.

databricks secrets delete-scope SCOPE [flags]

Arguments

SCOPE

    Nama cakupan yang akan dihapus.

Opsi

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

Bendera global

rahasia databricks menghapus rahasia

Hapus rahasia yang disimpan dalam cakupan rahasia ini. Anda harus memiliki izin WRITE atau MANAGE untuk cakupan rahasia.

Meletakkan pengecualian RESOURCE_DOES_NOT_EXIST jika tidak ada cakupan rahasia atau rahasia tersebut. PERMISSION_DENIED Melemparkan jika pengguna tidak memiliki izin untuk melakukan panggilan ini.

databricks secrets delete-secret SCOPE KEY [flags]

Arguments

SCOPE

    Nama cakupan yang berisi rahasia yang akan dihapus.

KEY

    Nama rahasia yang akan dihapus.

Opsi

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

Bendera global

rahasia databricks get-acl

Dapatkan detail tentang ACL yang diberikan, seperti grup dan izin. Pengguna harus memiliki MANAGE izin untuk memanggil API ini.

Melemparkan RESOURCE_DOES_NOT_EXIST jika tidak ada scope rahasia seperti itu. PERMISSION_DENIED Melemparkan jika pengguna tidak memiliki izin untuk melakukan panggilan ini.

databricks secrets get-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Nama cakupan untuk mengambil informasi ACL.

PRINCIPAL

    Perwakilan untuk mengambil informasi ACL.

Opsi

Bendera global

Databricks rahasia: get-secret

Dapatkan representasi dalam format byte dari nilai rahasia untuk cakupan dan kunci yang ditentukan.

Pengguna memerlukan READ izin untuk melakukan panggilan ini.

Perhatikan bahwa nilai rahasia yang dikembalikan dalam byte. Interpretasi byte ditentukan oleh pemanggil di DBUtils dan jenis data didekodekan.

PERMISSION_DENIED Akan melemparkan kesalahan jika pengguna tidak memiliki izin untuk melakukan panggilan API ini. Melemparkan RESOURCE_DOES_NOT_EXIST jika tidak ada rahasia atau cakupan rahasia yang sesuai.

databricks secrets get-secret SCOPE KEY [flags]

Arguments

SCOPE

    Nama cakupan untuk mengambil atau mengakses informasi rahasia.

KEY

    Kunci untuk mengakses rahasia.

Opsi

Bendera global

databricks secrets list-acls

Cantumkan ACL untuk cakupan rahasia tertentu. Pengguna harus memiliki MANAGE izin untuk memanggil API ini.

Melemparkan RESOURCE_DOES_NOT_EXIST jika tidak ada scope rahasia seperti itu. PERMISSION_DENIED Melemparkan jika pengguna tidak memiliki izin untuk melakukan panggilan ini.

databricks secrets list-acls SCOPE [flags]

Arguments

SCOPE

    Nama cakupan untuk mengambil informasi ACL.

Opsi

Bendera global

daftar cakupan rahasia databricks

Cantumkan semua ruang lingkup rahasia yang tersedia di ruang kerja.

PERMISSION_DENIED Melemparkan jika pengguna tidak memiliki izin untuk melakukan panggilan ini.

databricks secrets list-scopes [flags]

Opsi

Bendera global

rahasia databricks daftar-rahasia

Cantumkan kunci rahasia yang disimpan pada cakupan ini. Ini adalah operasi khusus metadata; data rahasia tidak dapat diambil menggunakan perintah ini. Pengguna memerlukan READ izin untuk melakukan panggilan ini.

Nilai lastUpdatedTimestamp yang dikembalikan adalah dalam milidetik sejak Epoch. Melemparkan RESOURCE_DOES_NOT_EXIST jika tidak ada scope rahasia seperti itu. PERMISSION_DENIED Melemparkan jika pengguna tidak memiliki izin untuk melakukan panggilan ini.

databricks secrets list-secrets SCOPE [flags]

Arguments

SCOPE

    Nama cakupan untuk mencantumkan rahasia di dalamnya.

Opsi

Bendera global

databricks secrets put-acl (menetapkan daftar kontrol akses)

Buat atau timpa Daftar Kontrol Akses (ACL) yang terkait dengan prinsipal tertentu (pengguna atau grup) pada titik cakupan yang ditentukan.

Secara umum, pengguna atau grup akan menggunakan izin paling kuat yang tersedia untuk mereka, dan izin diurutkan sebagai berikut:

  • MANAGE Diizinkan untuk mengubah ACL, dan membaca dan menulis ke cakupan rahasia ini.
  • WRITE Diizinkan untuk membaca dan menulis di wilayah rahasia ini.
  • READ Diizinkan untuk membaca cakupan rahasia ini dan mencantumkan rahasia apa yang tersedia.

Perhatikan bahwa secara umum, nilai rahasia hanya dapat dibaca dari dalam perintah pada kluster (misalnya, melalui buku catatan). Tidak ada API untuk membaca materi nilai rahasia aktual di luar kluster. Namun, izin pengguna akan diterapkan berdasarkan siapa yang menjalankan perintah, dan mereka harus memiliki setidaknya izin READ.

Pengguna harus memiliki MANAGE izin untuk memanggil perintah ini.

Prinsipal adalah nama pengguna atau grup yang sesuai dengan prinsipal Databricks yang ada yang akan diberikan atau dicabut aksesnya.

Melemparkan RESOURCE_DOES_NOT_EXIST jika tidak ada scope rahasia seperti itu. RESOURCE_ALREADY_EXISTS Melemparkan jika izin untuk prinsipal sudah ada. INVALID_PARAMETER_VALUE Dilemparkan apabila izin atau prinsipal tidak valid. PERMISSION_DENIED Melemparkan jika pengguna tidak memiliki izin untuk melakukan panggilan ini.

databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]

Arguments

SCOPE

    Nama cakupan dimana izin diterapkan.

PRINCIPAL

    Entitas tempat izin diterapkan.

PERMISSION

    Tingkat izin diterapkan kepada entitas utama. Nilai yang didukung: MANAGE, READ, WRITE

Opsi

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

Bendera global

rahasia databricks put-secret

Sisipkan rahasia di bawah cakupan yang disediakan dengan nama yang diberikan. Jika rahasia sudah ada dengan nama yang sama, perintah ini mengganti nilai rahasia yang ada. Server mengenkripsi rahasia menggunakan pengaturan enkripsi dalam lingkup rahasia sebelum menyimpannya.

Anda harus memiliki izin WRITE atau MANAGE untuk cakupan rahasia. Kunci rahasia harus terdiri dari karakter alfanumerik, tanda hubung, garis bawah, dan titik, dan tidak boleh melebihi 128 karakter. Ukuran nilai rahasia maksimum yang diizinkan adalah 128 KB. Jumlah maksimum rahasia dalam cakupan tertentu adalah 1000.

Argumen string-value atau bytes-value tentukan jenis rahasia, yang akan menentukan nilai yang dikembalikan saat nilai rahasia diminta.

Anda dapat menentukan nilai rahasia dengan salah satu dari tiga cara:

  • Tentukan nilai sebagai string dengan menggunakan penanda --string-value.
  • Masukkan rahasia saat diminta secara interaktif (rahasia satu baris).
  • Berikan rahasia melalui input standar (rahasia multibaris).
databricks secrets put-secret SCOPE KEY [flags]

Arguments

SCOPE

    Nama cakupan untuk menyimpan data rahasia.

KEY

    Nama kunci untuk rahasia.

Opsi

--bytes-value string

    Jika ditentukan, nilai akan disimpan sebagai byte.

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

--string-value string

    Jika ditentukan, perhatikan bahwa nilai akan disimpan dalam formulir UTF-8 (MB4).

Bendera global

Bendera dunia

--debug

  Apakah akan mengaktifkan pengelogan debug.

-h atau --help

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

--log-file tali

    String yang mewakili file 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 yang ~/.databrickscfg akan 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