Referensi tombol API Pengaturan

Halaman ini mencantumkan pengaturan yang tersedia melalui API Azure Databricks Settings publik, dikelompokkan berdasarkan cakupan. Setiap pengaturan diidentifikasi dengan nama pengaturan stabil (kunci). Untuk cara menemukan, membaca, dan memperbarui pengaturan ini, lihat Kelola pengaturan melalui API Pengaturan.

Pratinjau fitur juga dikelola melalui API Pengaturan tetapi tidak tercantum di sini, karena bersifat sementara dan akhirnya mencapai akhir masa pakainya. Temukan pratinjau yang saat ini tersedia untuk Anda melalui endpoint settings-metadata.

Pengaturan yang tersedia

Pengaturan berikut tersedia melalui API Pengaturan publik, dikelompokkan berdasarkan cakupan. Daftar ini dihasilkan secara berkala; Untuk set pengaturan otoritatif dan selalu terkini serta tautan dokumentasinya, panggil endpoint Settings-metadata, yang mengembalikan , namedescription, type, dan docs_link.

Pengaturan akun

Pengaturan yang berlaku di seluruh akun.

Setting Nama kunci Deskripsi
Nonaktifkan fitur warisan disable_legacy_features Nonaktifkan fitur warisan untuk workspace Databricks baru. Untuk ruang kerja yang baru dibuat: 1. Menonaktifkan penggunaan root dan mount DBFS. 2. Hive Metastore tidak akan difasilitasi. 3. Menonaktifkan penggunaan 'Klaster tanpa isolasi'. 4. Menonaktifkan versi runtime Databricks sebelum 13.3LTS.
Terapkan Unity Gateway enforce_ai_gateway_v3_only Mengontrol apakah semua akses model foundation harus melalui Unity Gateway. Ketika diaktifkan, izin akses model, anggaran AI, dan kebijakan keamanan dikelola secara terpusat dengan Unity Gateway, dan semua lalu lintas model dasar harus melewati proses tersebut. Model foundation legacy melayani endpoint yang melewati lalu lintas penolakan Unity Gateway.
Fitur AI yang didukung mitra llm_proxy_partner_powered Menentukan apakah model bertenaga mitra diaktifkan atau tidak. Pengaturan ini tersedia di tingkat akun maupun workspace
Terapkan fitur AI berbasis mitra llm_proxy_partner_powered_enforce Menentukan apakah pengaturan penegakan yang didukung oleh mitra aktif. Saat diaktifkan, nilai berbasis mitra tingkat akun akan menimpa override di tingkat workspace.
Batasi Admin Workspace restrict_workspace_admins Pengaturan Batasi Admin Ruang Kerja memungkinkan Anda mengontrol kemampuan admin ruang kerja. Dengan status pengaturan diatur ke ALLOW_ALL, admin workspace dapat membuat token akses pribadi service principal atas nama service principal mana pun di workspace mereka. Admin ruang kerja juga dapat mengubah pemilik pekerjaan menjadi pengguna mana pun di ruang kerja mereka. Dan mereka dapat mengubah pengaturan run_as pekerjaan ke pengguna mana pun di workspace mereka atau ke service principal yang memiliki peran Service Principal User di dalamnya. Dengan status pengaturan diatur ke RESTRICT_TOKENS_AND_JOB_RUN_AS, admin workspace hanya dapat membuat token akses pribadi atas nama service principal yang mereka gunakan sebagai Service Principal User User. Mereka juga hanya dapat mengubah pemilik pekerjaan menjadi diri mereka sendiri. Dan mereka dapat mengubah pengaturan run_as pekerjaan kepada diri mereka sendiri atau ke service principal yang mereka gunakan sebagai Service Principal User di dalamnya.

Pengaturan ruang kerja

Pengaturan yang berlaku untuk satu workspace.

Setting Nama kunci Deskripsi
Kebijakan Akses Penyematan Dashboard AI/BI aibi_dash_embed_ws_acc_policy Mengontrol apakah penyematan dashboard yang dipublikasikan AI/BI diaktifkan, diaktifkan secara kondisional, atau dinonaktifkan di tingkat workspace. Secara default, pengaturan ini diaktifkan secara kondisional (ALLOW_APPROVED_DOMAINS).
Dashboard AI/BI Menanamkan Domain yang Disetujui aibi_dash_embed_ws_apprvd_domains Mengontrol daftar domain yang disetujui untuk menjadi host dasbor AI/BI tertanam. Daftar domain yang disetujui tidak dapat diubah jika kebijakan akses saat ini tidak diatur ke ALLOW_APPROVED_DOMAINS.
Batasi cakupan OAuth untuk aplikasi hanya pada nilai yang dipilih allowedAppsUserApiScopes Batasi lingkup OAuth mana yang dapat diminta pengembang aplikasi saat bertindak atas nama pengguna. Tentukan daftar cakupan yang diizinkan, atau gunakan "*" untuk mengizinkan semua cakupan yang didukung. Daftar kosong secara efektif menonaktifkan otorisasi pengguna untuk aplikasi.
Pembaruan kluster otomatis automatic_cluster_update Pembaruan kluster otomatis memastikan bahwa semua kluster di ruang kerja diperbarui secara berkala ke gambar OS host terbaru dan pembaruan keamanan. Admin akun dapat menjadwalkan frekuensi jendela pemeliharaan, tanggal mulai, dan waktu mulai. Berlaku untuk komputasi klasik (klaster, pool, gudang SQL klasik, Pelayanan Model warisan); ini tidak berlaku untuk komputasi serverless. Mengaktifkan fitur ini menambahkan add-on Enhanced Security and Compliance dan memerlukan tier harga Premium.
Platform kolaborasi yang diizinkan collaboration_platform_connectivity Mengontrol platform kolaborasi eksternal mana (Slack dan/atau Microsoft Teams) yang dapat terhubung ke workspace ini. Default ke ALLOW_ALL.
Izinkan pesan publik di platform kolaborasi collaboration_platform_message_visibility Saat diaktifkan, pengguna dapat memilih apakah respons dari aplikasi Databricks di Slack atau Microsoft Teams terlihat oleh saluran. Saat dinonaktifkan, semua respons dipaksa bersifat privat bagi pengguna yang meminta.
Akses ruang kerja untuk personel Databricks customerApprovedWSLoginExpirationTime Waktu tertentu setelah itu personel Databricks tidak lagi dapat masuk ke ruang kerja Anda. Waktu diformat sebagai YYYY-MM-DDTHH:MM:SSZ. Anda dapat menonaktifkan akses sepenuhnya dengan mengaturnya ke timestamp di masa lalu, seperti 1998-01-01T00:00:00.000Z. Aktifkan akses tanpa batas dengan menggunakan string kosong atau nilai indefinitekhusus .
Default Namespace default_namespace_ws API pengaturan namespace default memungkinkan pengguna mengonfigurasi namespace default untuk workspace Databricks.
Nonaktifkan akses warisan disable_legacy_access 'Menonaktifkan akses warisan' memiliki dampak sebagai berikut: 1. Menonaktifkan akses langsung ke Hive Metastore dari workspace (akses melalui federasi Hive Metastore tidak terpengaruh). 2. Menonaktifkan mode fallback pada akses lokasi eksternal dari ruang kerja. 3. Menonaktifkan versi runtime Databricks sebelum 13.3LTS. Penting: pengaturan ini tidak dapat diaktifkan saat katalog default workspace diatur ke katalog warisan (hive_metastore atau spark_catalog). Ubah katalog default menjadi katalog Unity Catalog terlebih dahulu.
Menonaktifkan akar dan pemasangan DBFS disable_legacy_dbfs Menonaktifkan DBFS warisan memiliki dua implikasi berikut: 1. Akses ke root DBFS dan mount DBFS dilarang (begitu juga pembuatan mount baru). 2. Menonaktifkan versi runtime Databricks sebelum 13.3LTS. Ketika pengaturan dimatikan, semua fungsi DBFS diaktifkan dan tidak ada pembatasan yang dikenakan pada versi Databricks Runtime. Pengaturan ini dapat memakan waktu hingga 20 menit untuk berlaku dan memerlukan restart manual pada klaster komputasi serbaguna dan gudang SQL.
Aktifkan tipe node otomatis fleksibel enableAutoNodeTypeFlexibility Saat diaktifkan, klaster di workspace ini dapat secara otomatis dijalankan pada tipe node alternatif ketika tipe node yang diminta tidak tersedia, meningkatkan keandalan peluncuran selama kekurangan kapasitas.
Terapkan Unity Gateway enforce_ai_gateway_v3_only Mengontrol apakah semua akses model foundation harus melalui Unity Gateway. Ketika diaktifkan, izin akses model, anggaran AI, dan kebijakan keamanan dikelola secara terpusat dengan Unity Gateway, dan semua lalu lintas model dasar harus melewati proses tersebut. Model foundation legacy melayani endpoint yang melewati lalu lintas penolakan Unity Gateway.
Hanya izinkan penyebaran aplikasi dari Git enforceGitAppDeployments Saat diaktifkan, aplikasi di workspace ini hanya dapat dideploy dari Git.
Fitur AI yang didukung mitra llm_proxy_partner_powered Menentukan apakah model bertenaga mitra diaktifkan atau tidak. Pengaturan ini tersedia di tingkat akun maupun workspace
Misi Kritis mission_critical Memberikan tingkat ketahanan operasional dan keamanan tertinggi untuk beban kerja kritis. Termasuk pemulihan bencana serta peningkatan keamanan dan kepatuhan.
Izinkan repositori mengekspor output IPYNB reposIpynbResultsExportPermissions Mengontrol apakah pengguna dapat melakukan commit output notebook .ipynb ke repositori Git jarak jauh di workspace.
Batasi Admin Workspace restrict_workspace_admins Pengaturan Batasi Admin Ruang Kerja memungkinkan Anda mengontrol kemampuan admin ruang kerja. Dengan status pengaturan diatur ke ALLOW_ALL, admin workspace dapat membuat token akses pribadi service principal atas nama service principal mana pun di workspace mereka. Admin ruang kerja juga dapat mengubah pemilik pekerjaan menjadi pengguna mana pun di ruang kerja mereka. Dan mereka dapat mengubah pengaturan run_as pekerjaan ke pengguna mana pun di workspace mereka atau ke service principal yang memiliki peran Service Principal User di dalamnya. Dengan status pengaturan diatur ke RESTRICT_TOKENS_AND_JOB_RUN_AS, admin workspace hanya dapat membuat token akses pribadi atas nama service principal yang mereka gunakan sebagai Service Principal User User. Mereka juga hanya dapat mengubah pemilik pekerjaan menjadi diri mereka sendiri. Dan mereka dapat mengubah pengaturan run_as pekerjaan kepada diri mereka sendiri atau ke service principal yang mereka gunakan sebagai Service Principal User di dalamnya.
Profil keamanan kepatuhan shield_csp_enablement_ws_db Mengontrol apakah profil keamanan kepatuhan diaktifkan untuk workspace ini. Profil keamanan kepatuhan menyediakan baseline yang sangat aman (pemantauan tambahan, citra komputasi yang diperkuat, tipe instance yang ditegakkan untuk enkripsi antar-node, dan kontrol lainnya) yang memudahkan pemenuhan dan pengelolaan standar kepatuhan yang berlaku. Mengaktifkannya juga secara permanen memungkinkan pemantauan keamanan yang ditingkatkan dan pembaruan klaster otomatis di workspace, serta menambahkan add-on Enhanced Security and Compliance.
Pemantauan keamanan yang ditingkatkan shield_esm_enablement_ws_db Mengontrol apakah pemantauan keamanan yang ditingkatkan diaktifkan untuk workspace ini. Pemantauan keamanan yang ditingkatkan menyediakan citra komputasi yang diperkuat dan agen pemantauan keamanan tambahan (pemantauan integritas file, antivirus, dan pemindaian kerentanan) yang menghasilkan baris log yang dapat ditinjau. Ini hanya berlaku untuk sumber daya komputasi klasik, bukan serverless. Jika profil keamanan kepatuhan diaktifkan di workspace, pengaturan ini akan diterapkan secara permanen.
Workspace Label workspace_label Label khusus dan lencana warna ditampilkan di samping nama workspace pada navigasi atas konsol Databricks. Administrator workspace dapat menggunakan pengaturan ini untuk membedakan workspace secara visual di berbagai lingkungan. Nilai adalah objek dengan label bidang (string teks) dan bidang color (salah satu: coral, lemon, , limeturquoise, indigopurplepink, ). Kedua bidang tersebut adalah string kosong ketika tidak ada label yang diatur.

Preferensi pengguna

Pengaturan yang berlaku untuk pengguna dalam sebuah akun.

Setting Nama kunci Deskripsi
Secara otomatis membuat sesi pada interaksi editor autoCreateSessionOnEditorInteraction Mengontrol apakah sesi dibuat secara otomatis saat berinteraksi dengan editor.
Peluncuran dan Pasang Otomatis autoLaunchAndAttach Mengontrol apakah notebook secara otomatis berjalan dan terhubung ke cluster.
Konfirmasi Perintah Hapus confirmCommandDelete Mengontrol apakah konfirmasi diperlukan sebelum menghapus perintah.
Buat aset baru di folder Drafts createNewAssetsInDraftsFolder Mengontrol apakah aset baru dibuat di folder drafts.
Databricks Unified SQL Editor Buat dan Konversi Kueri di Open Pref databricks-unified-sql-editor-create-and-convert-queries-on-open-pref Mengontrol perilaku pembuatan dan konversi kueri di editor SQL terpadu.
Unit Indentasi Python Default defaultPythonIndentUnit Mengontrol unit indentasi Python default. Nilai yang diizinkan: 2, , 4atau '' (string kosong sebagai default).
Editor Tema Gelap Kustom editorCustomDarkTheme Mengontrol tema gelap kustom untuk editor. Nilai yang diizinkan: , , defaultTheme, , Atom-One-DarkAyu-DarkBlackboardDraculaGitHub-DarkMonokaiOne-Dark-ProWinter-is-Coming-Dark
Editor Tema Cahaya Kustom editorCustomLightTheme Mengontrol tema cahaya khusus untuk editor. Nilai yang diizinkan: defaultTheme, , Active4DAtom-One-Light, Ayu-Light, GitHub-Light, Tomorrow, Winter-is-Coming-Light.
Ukuran font editor editorFontSize Mengontrol ukuran font di editor. Nilai yang diizinkan: rentang bilangan bulat dari 10 hingga 30.
Aktifkan Perbaikan Cepat Otomatis Inline enableAutoInlineQuickFix Mengontrol apakah solusi cepat inline secara otomatis disarankan.
Aktifkan Auto Inline Quick Fix Opt Out enableAutoInlineQuickFixOptOut Kontrol opt-out untuk perbaikan cepat otomatis inline.
Aktifkan Diagnosis Pemicu Otomatis enableAutoTriggerDiagnose Mengontrol apakah diagnostik secara otomatis dipicu.
Aktifkan Auto Trigger Diagnosis Opt Out enableAutoTriggerDiagnoseOptOut Kontrol opt-out untuk diagnostik otomatis.
Aktifkan Tata Letak Terpusat enableCenteredLayout Mengontrol apakah editor menggunakan tata letak yang terpusat.
Aktifkan Pintasan Klasik enableClassicShortcuts Mengontrol mode pintasan keyboard. Nilai yang diizinkan: default, classic.
Aktifkan Nomor Perintah enableCommandNumbers Mengontrol apakah nomor perintah ditampilkan di notebook.
Aktifkan Penyelesaian Saat Anda Mengetik enableCompletionsAsYouType Mengontrol apakah saran autocomplete muncul saat Anda mengetik.
Aktifkan Cursor Blink enableCursorBlink Mengontrol apakah kursor berkedip di editor.
Aktifkan Mode Gelap enableDarkMode Mengontrol mode tema. Nilai yang diizinkan: light, dark, dan system.
Aktifkan Masukkan Menerima Saran enableEnterAcceptsSuggestions Mengontrol apakah menekan Enter menerima saran autocomplete.
Aktifkan Hover Untuk Editor enableHoverForEditor Mengontrol apakah tooltip hover ditampilkan di editor.
Aktifkan Saran Inline Saat Anda Mengetik Opt Out enableInlineSuggestionAsYouTypeOptOut Kontrol opt-out untuk saran inline saat Anda mengetik.
Aktifkan Nomor Baris enableLineNumbers Mengontrol apakah nomor baris ditampilkan di editor.
Aktifkan Nomor Baris V2 enableLineNumbersV2 Mengontrol apakah nomor baris ditampilkan di editor (v2).
Aktifkan Line Wrap enableLineWrap Mengontrol apakah teks dibungkus ke baris berikutnya di editor.
Aktifkan Monaco Multi Cursor enableMonacoMultiCursor Mengontrol tombol modifikator multi-kursor. Nilai yang diizinkan: alt, ctrlCmd.
Aktifkan Opsi Keluar Debugger Notebook enableNotebookDebuggerOptOut Kontrol opt-out untuk debugger notebook.
Aktifkan Toggle Observabilitas Serverless enableServerlessObservabilityToggle Pengguna memilih untuk Improved Serverless Observability di Jobs saat pratinjau workspace diaktifkan.
Aktifkan Tampilkan Statistik Perintah di Antarmuka Sel Baru enableShowCommandStatsInNewCellUi Mengontrol apakah statistik perintah ditampilkan di antarmuka sel baru.
Aktifkan Tampilkan Judul Sel yang Dipromosikan enableShowPromotedCellTitles Mengontrol apakah judul sel yang dipromosikan ditampilkan.
Aktifkan Kutipan Pintar enableSmartQuotes Mengontrol apakah tanda kutip pintar diaktifkan di editor.
Aktifkan Tab Lunak untuk Notebook dan File enableSoftTabsForNotebooksAndFiles Mengontrol apakah tab diubah menjadi spasi di buku catatan dan file.
Aktifkan Penyorotan Kesalahan Sintaks SQL enableSqlSyntaxErrorHighlighting Mengontrol apakah kesalahan sintaks SQL disorot.
Aktifkan Beralih ke Mode Perintah Setelah Eksekusi enableSwitchToCommandModeAfterExecution Mengontrol apakah editor beralih ke mode perintah setelah eksekusi sel.
Aktifkan File Tree Explorer Terpadu enableUnifiedFileTreeExplorer Mengontrol apakah penjelajah pohon file terpadu diaktifkan.
Fokus enableUnifiedSchemaBrowserTreeExplorer Mengontrol apakah unified schema browser tree explorer diaktifkan.
Aktifkan Vega Lite Renderer enableVegaLiteRenderer Mengontrol apakah renderer Vega-Lite diaktifkan untuk visualisasi.
Aktifkan Vega Lite Renderer Opt Out enableVegaLiteRendererOptOut Kontrol opt-out untuk renderer Vega-Lite.
Aktifkan Vega Lite Renderer Preview Tag enableVegaLiteRendererPreviewTag Mengontrol apakah tag pratinjau renderer Vega-Lite ditampilkan.
Panel bawah yang diperpanjang extendedBottomPanel Mengontrol apakah panel bawah yang diperluas ditampilkan.
Antarmuka Pemantauan Pipa Baru Lakeflow lakeflowNewPipelinesMonitoringUi Mengontrol apakah UI pemantauan pipa Lakeflow baru diaktifkan.
Format Ekspor Default Notebook notebookDefaultExportFormat Mengontrol format ekspor default untuk notebook. Nilai yang diizinkan: SOURCE, JUPYTER.
Mode Pintasan Panah Opsi optionArrowShortcutMode Mengontrol perilaku pintasan keyboard Option+Arrow. Nilai yang diizinkan: navigate, move.
Pembuatan Multifile Pipeline pipelinesMultifileAuthoring Mengontrol apakah pembuatan multifile diaktifkan untuk pipeline.
Kirim Notifikasi Email Komentar sendCommentEmailNotifications Mengontrol apakah notifikasi email dikirim untuk komentar.
Tampilkan minimap eksekusi sel showCellExecutionMinimap Mengontrol apakah minimap eksekusi sel ditampilkan.
Tampilkan Prompt Panel Pip Ke Lingkungan showPipToEnvironmentPanelPrompt Mengontrol apakah akan menampilkan pip ke prompt panel lingkungan.
Tampilkan Spark Advisor showSparkAdvisor Mengontrol apakah saran optimasi Spark ditampilkan.
Tunjukkan Tips Kesalahan Percikan showSparkErrorTips Mengontrol apakah tips berguna ditampilkan untuk kesalahan Spark.
Pengguna mengaktifkan penyorotan kesalahan format Python userActivatesPythonFormatErrorHighlighting Mengontrol apakah kesalahan pemformatan Python disorot.
Pengguna mengaktifkan kesalahan sintaks Python saat memilih keluar userActivatesPythonSyntaxErrorHighlightingOptOut Kontrol opt-out untuk penyorotan kesalahan sintaks Python.
Pengguna mengaktifkan pemeriksaan tipe Python userActivatesPythonTypeChecking Mengontrol apakah pemeriksaan tipe Python diaktifkan.
Pengguna mengaktifkan pemulihan snapshot userActivatesSnapshotRestore Mengontrol apakah fungsi pemulihan snapshot diaktifkan.
Batas default 1000 untuk kueri baru usqleDefaultQueryAutoLimit Mengontrol batas otomatis default untuk kueri SQL di editor.

Sumber daya tambahan

  • Terakhir diperbarui pada