設定 API 鍵參考

本頁列出透過公開的 Azure Databricks 設定 API 提供的設定，依範圍分組。 每個設定都以穩定 的設定名稱 （key）來識別。 關於如何發現、閱讀及更新這些設定，請參閱 透過設定 API 管理設定。

功能預覽也透過設定 API 管理，但此處未列出，因為它們是暫時性的，最終會終止生命週期。 透過 設定-元資料端點，發現目前可用的預覽版本。

可用的設定

以下設定可透過公開設定 API 依範圍分組使用。 此列表會定期產生;對於權威且始終最新的設定集及其文件連結，呼叫 settings-metadata 端點，該端點會回傳每個設定的 name、 description、 type、 docs_link和 。

帳號設定

適用於整個帳號的設定。

Setting 鍵名稱 Description
停用舊有功能 disable_legacy_features 關閉新 Databricks 工作區的舊有功能。 對於新建立的工作區：1. 禁用 DBFS 根與掛載的使用。 2. Hive Metastore 不會被配置。 3. 禁止使用「無隔離叢集」。 4. 停用 13.3LTS 之前的 Databricks 執行時版本。
強化 Unity 閘道 enforce_ai_gateway_v3_only 控制所有基礎模型存取是否必須透過 Unity Gateway 進行。 啟用後，模型存取權限、AI 預算及安全政策皆由 Unity Gateway 集中管理，所有基礎模型流量都必須通過該閘道。 服務繞過 Unity Gateway 的端點的舊有基礎模型會拒絕流量。
合作夥伴驅動的 AI 功能 llm_proxy_partner_powered 決定是否啟用合作夥伴驅動的模型。 此設定同時可在帳號層級與工作區層級使用
強制執行合作夥伴驅動的 AI 功能 llm_proxy_partner_powered_enforce 判斷夥伴驅動強制設定是否開啟。 啟用後，帳戶層級的合作夥伴驅動值會覆蓋任何工作區層級的覆蓋。
限制工作區管理員 restrict_workspace_admins [限制工作區管理員] 設定可讓您控制工作區系統管理員的功能。 當設定狀態設為 ALLOW_ALL 時，工作區管理員可以代表工作區中任一服務主體建立服務主體的個人存取權杖。 工作區系統管理員也可以將作業擁有者變更為其工作區中的任何使用者。 他們也可以將工作run_as設定改成工作空間中的任何使用者，或是他們擁有服務主體使用者角色的服務主體。 當設定狀態設為 RESTRICT_TOKENS_AND_JOB_RUN_AS 時，工作區管理員只能代表他們擁有服務主體使用者角色的服務主體建立個人存取權杖。 他們也只能將作業所有者變更為自己。 他們也可以將工作run_as設定改為自己，或切換到擁有服務主體使用者角色的服務主體。

工作區設定

適用於單一工作區的設定。

Setting 鍵名稱 Description
AI/BI 儀表板嵌入存取政策 aibi_dash_embed_ws_acc_policy 控制 AI/BI 發布的儀表板嵌入在工作區層級是否啟用、條件啟用或停用。預設情況下，此設定為條件啟用（ALLOW_APPROVED_DOMAINS）。
AI/BI 儀表板嵌入核准網域 aibi_dash_embed_ws_apprvd_domains 控制已核准承載嵌入式 AI/BI 儀表板的網域清單。當目前的存取政策未設為ALLOW_APPROVED_DOMAINS時，核准網域清單無法被變更。
限制應用程式的 OAuth 範圍為選取的值 allowedAppsUserApiScopes 限制應用程式開發者代表使用者時可申請的OAuth範圍。 指定允許的範圍清單，或使用「*」來允許所有支援的範圍。 空清單實際上會讓應用程式無法取得使用者授權。
自動叢集更新 automatic_cluster_update 自動叢集更新可確保工作區中的所有叢集都會定期更新為最新的主機 OS 映像和安全性更新。 帳戶管理員可以排程維護時段頻率、開始日期和開始時間。 適用於經典運算（叢集、池、經典 SQL 倉庫、舊有模型服務）;這不適用於無伺服器運算。 啟用此功能會新增強化安全性與合規附加元件，並需選擇高級定價等級。
允許的協作平台 collaboration_platform_connectivity 控制哪些外部協作平台（Slack 和/或 Microsoft Teams）可以連接到這個工作空間。 預設是ALLOW_ALL。
允許在協作平台上公開訊息 collaboration_platform_message_visibility 啟用後，使用者可選擇 Slack 或 Microsoft Teams 中 Databricks 應用程式的回應是否會被頻道看到。 當回應被停用時，所有回應都必須對請求者保密。
Databricks 人員存取工作空間 customerApprovedWSLoginExpirationTime 在特定時間之後，Databricks 人員將不再登入您的工作區。 時間格式為 YYYY-MM-DDTHH:MM:SSZ。 你可以完全停用存取權限，方法是設定過去的時間戳記，例如 1998-01-01T00:00:00.000Z。 透過使用空字串或特殊值 indefinite來無限期啟用存取。
預設命名空間 default_namespace_ws 預設命名空間設定 API 允許使用者設定 Databricks 工作區的預設命名空間。
停用舊有存取權限 disable_legacy_access 「停用舊有存取」有以下影響：1. 關閉從工作區直接存取 Hive Metastore（透過 Hive Metastore 聯盟的存取不受影響）。 2. 從工作區禁用外部位置存取的後備模式。 3. 停用 13.3LTS 之前的 Databricks 執行時版本。 重要提示：當工作區預設目錄設定為舊有目錄（hive_metastore或spark_catalog）時，此設定無法啟用。 先把預設目錄改成 Unity 目錄。
停用 DBFS 根目錄和掛接 disable_legacy_dbfs 停用舊有 DBFS 有以下兩個意涵：1. 禁止存取 DBFS 根目錄與 DBFS 掛載（以及建立新的掛載）。 2. 停用 13.3LTS 之前的 Databricks 執行時版本。 當設定關閉時，所有 DBFS 功能都會被啟用，且對 Databricks 執行時版本不會有任何限制。 此設定可能需要長達 20 分鐘才能生效，且需手動重新啟動多功能運算叢集與 SQL 倉庫。
強化 Unity 閘道 enforce_ai_gateway_v3_only 控制所有基礎模型存取是否必須透過 Unity Gateway 進行。 啟用後，模型存取權限、AI 預算及安全政策皆由 Unity Gateway 集中管理，所有基礎模型流量都必須通過該閘道。 服務繞過 Unity Gateway 的端點的舊有基礎模型會拒絕流量。
只允許從 Git 部署應用程式 enforceGitAppDeployments 啟用後，工作空間中的應用程式只能從 Git 部署。
合作夥伴驅動的 AI 功能 llm_proxy_partner_powered 決定是否啟用合作夥伴驅動的模型。 此設定同時可在帳號層級與工作區層級使用
關鍵任務 mission_critical 為關鍵工作負載提供最高水準的營運韌性與安全性。 包含災難復原以及強化的安全性與合規性。
允許 repo 匯出 IPYNB 輸出 reposIpynbResultsExportPermissions 控制使用者是否能將 .ipynb 筆記本輸出提交到工作區中的遠端 Git 倉庫。
限制工作區管理員 restrict_workspace_admins [限制工作區管理員] 設定可讓您控制工作區系統管理員的功能。 當設定狀態設為 ALLOW_ALL 時，工作區管理員可以代表工作區中任一服務主體建立服務主體的個人存取權杖。 工作區系統管理員也可以將作業擁有者變更為其工作區中的任何使用者。 他們也可以將工作run_as設定改成工作空間中的任何使用者，或是他們擁有服務主體使用者角色的服務主體。 當設定狀態設為 RESTRICT_TOKENS_AND_JOB_RUN_AS 時，工作區管理員只能代表他們擁有服務主體使用者角色的服務主體建立個人存取權杖。 他們也只能將作業所有者變更為自己。 他們也可以將工作run_as設定改為自己，或切換到擁有服務主體使用者角色的服務主體。
合規安全設定 shield_csp_enablement_ws_db 控制此工作區是否啟用合規安全設定檔。 合規安全設定檔提供高度安全的基線（額外監控、強化運算映像、強制執行的節點間加密實例類型及其他控制措施），使符合與管理適用的合規標準變得更容易。 啟用此功能同時也永久啟用了工作空間的強化安全監控與叢集自動更新，並新增了增強安全性與合規附加元件。
增強的安全性監視 shield_esm_enablement_ws_db 控制此工作區是否啟用增強的安全監控。 強化安全監控提供強化的運算映像檔及額外的安全監控代理程式（檔案完整性監控、防毒軟體及漏洞掃描），產生可審查的日誌列。 它只適用於經典的運算平面資源，不適用於無伺服器。 若工作區啟用合規安全設定檔，此設定將永久執行。
工作區標籤 workspace_label 在 Databricks 控制台頂部導覽中，工作區名稱旁顯示一個自訂標籤和顏色徽章。 工作區管理員可使用此設定在不同環境中視覺區分工作區。 該值是一個物件，包含一個label欄位（文字字串）和一個color欄位（其中一個：coral， turquoiselimeindigolemonpurple， ）。 pink 當沒有設定標籤時，兩個欄位都是空字串。

使用者喜好設定

適用於帳號使用者的設定。

Setting 鍵名稱 Description
自動建立編輯互動時的會話 autoCreateSessionOnEditorInteraction 控制與編輯器互動時是否自動建立會話。
自動發射並附著 autoLaunchAndAttach 控制筆記型電腦是否自動啟動並連接到叢集。
確認指令刪除 confirmCommandDelete 控制刪除指令前是否需要確認。
在草稿資料夾中建立新資產 createNewAssetsInDraftsFolder 控制草稿資料夾中是否建立新資產。
Databricks 統一 SQL 編輯器 在 Open Pref 上建立並轉換查詢 databricks-unified-sql-editor-create-and-convert-queries-on-open-pref 控制統一 SQL 編輯器中的查詢建立與轉換行為。
預設 Python 縮排單元 defaultPythonIndentUnit 控制預設的 Python 縮排單元。 允許的值有： 2、、 4或「」（預設為空字串）。
編輯器自訂暗黑主題 editorCustomDarkTheme 控制編輯器的自訂暗色主題。 允許的值：defaultTheme， Atom-One-Dark， Ayu-DarkBlackboardDraculaGitHub-Dark， ， Monokai， ， One-Dark-Pro， 。 Winter-is-Coming-Dark
編輯器自訂光源主題 editorCustomLightTheme 控制編輯器的自訂燈光主題。 允許的值：defaultTheme、Active4D、、Atom-One-LightAyu-Light、GitHub-Light、Tomorrow、。 Winter-is-Coming-Light
編輯器字型大小 editorFontSize 在編輯器中控制字型大小。 允許的值：整數範圍為 10 到 30。
啟用自動內嵌快速修正 enableAutoInlineQuickFix 控制是否自動建議內嵌快速修正。
啟用自動內嵌快速修正 選擇退出 enableAutoInlineQuickFixOptOut 自動線上快速修正的選擇退出控制。
啟用自動觸發診斷 enableAutoTriggerDiagnose 控制診斷是否自動觸發。
啟用自動觸發診斷 選擇退出 enableAutoTriggerDiagnoseOptOut 自動診斷的選擇退出控制。
啟用置中佈局 enableCenteredLayout 控制編輯器是否使用居中版面。
啟用經典捷徑 enableClassicShortcuts 控制鍵盤快捷鍵模式。 允許的值： default、 classic。
啟用指令號碼 enableCommandNumbers 控制指令號碼是否顯示在筆記本中。
在你打字時啟用補全 enableCompletionsAsYouType 控制自動補全建議是否在你輸入時出現。
啟用游標閃爍 enableCursorBlink 控制游標在編輯器中是否閃爍。
啟用暗黑模式 enableDarkMode 控制主題模式。 允許值：light、dark、system。
啟用、進入、接受建議 enableEnterAcceptsSuggestions 控制按下 Enter 是否接受自動補全建議。
啟用編輯器滑鼠懸停 enableHoverForEditor 控制是否顯示滑鼠搖標工具提示於編輯器中。
在你打字時啟用內嵌建議，選擇退出 enableInlineSuggestionAsYouTypeOptOut 在您輸入時，對內線建議提供選擇退出控制。
啟用行號 enableLineNumbers 控制編輯器中是否顯示行號。
啟用線號 V2 enableLineNumbersV2 控制編輯器（v2）是否顯示行號。
啟用線環 enableLineWrap 控制編輯器中文字是否會換行到下一行。
啟用 Monaco 多重游標 enableMonacoMultiCursor 控制多游標修飾鍵。 允許的值： alt、 ctrlCmd。
啟用筆記本除錯器 選擇退出 enableNotebookDebuggerOptOut 筆記型電腦除錯器的選擇退出控制。
啟用無伺服器可觀察性切換 enableServerlessObservabilityToggle 當工作區預覽啟用時，使用者可選擇加入工作中改進的無伺服器可觀察性。
在新儲存格介面中啟用顯示指令統計 enableShowCommandStatsInNewCellUi 控制指令統計值是否會在新的儲存格介面中顯示。
啟用節目推廣區標題 enableShowPromotedCellTitles 控制是否顯示推廣的手機標題。
啟用智慧報價 enableSmartQuotes 控制編輯器中是否啟用智慧引號。
啟用筆記本與檔案的軟分頁 enableSoftTabsForNotebooksAndFiles 控制筆記本和檔案中分頁是否會轉換成空白。
啟用 SQL 語法錯誤標示 enableSqlSyntaxErrorHighlighting 控制 SQL 語法錯誤是否被標示。
執行後啟用切換至指令模式 enableSwitchToCommandModeAfterExecution 控制編輯器在儲存格執行後是否切換到指令模式。
啟用統一檔案樹檔案總管 enableUnifiedFileTreeExplorer 控制是否啟用統一檔案樹總管。
焦點 enableUnifiedSchemaBrowserTreeExplorer 控制是否啟用統一結構瀏覽器樹狀檔案總管。
啟用 Vega Lite 渲染器 enableVegaLiteRenderer 控制 Vega-Lite 渲染器是否啟用以進行視覺化。
啟用 Vega Lite 渲染器 選擇退出 enableVegaLiteRendererOptOut Vega-Lite 渲染器的選擇退出控制。
啟用 Vega Lite Renderer 預覽標籤 enableVegaLiteRendererPreviewTag 控制是否顯示 Vega-Lite 渲染器預覽標籤。
延伸底板 extendedBottomPanel 控制是否顯示延伸的底部面板。
Lakeflow 新管線監控介面 lakeflowNewPipelinesMonitoringUi 控制是否啟用新的 Lakeflow 管線監控介面。
筆記本預設匯出格式 notebookDefaultExportFormat 控制筆記本的預設匯出格式。 允許的值： SOURCE、 JUPYTER。
選項箭頭捷徑模式 optionArrowShortcutMode 控制 Option+Arrow 鍵盤快捷鍵的行為。 允許的值： navigate、 move。
管線多檔撰寫 pipelinesMultifileAuthoring 控制管線是否啟用多檔撰寫功能。
發送評論 電子郵件通知 sendCommentEmailNotifications 控制是否發送電子郵件通知徵求評論。
顯示儲存格執行小地圖 showCellExecutionMinimap 控制單元執行小地圖是否顯示。
顯示 Pip 到環境面板提示 showPipToEnvironmentPanelPrompt 控制是否要將 PIP 顯示給環境面板的提示。
節目火花顧問 showSparkAdvisor 控制是否顯示 Spark 優化建議。
Show Spark 錯誤提示 showSparkErrorTips 控制是否顯示對 Spark 錯誤的有用提示。
使用者啟用 Python 格式錯誤高亮 userActivatesPythonFormatErrorHighlighting 控制是否標示 Python 格式錯誤。
使用者啟用 Python 語法錯誤，顯示選擇退出 userActivatesPythonSyntaxErrorHighlightingOptOut Python 語法錯誤高亮的選擇退出控制。
使用者啟用 Python 型別檢查 userActivatesPythonTypeChecking 控制是否啟用 Python 型別檢查。
使用者啟動快照還原 userActivatesSnapshotRestore 控制是否啟用快照還原功能。
新查詢預設上限為 1000 usqleDefaultQueryAutoLimit 控制編輯器中 SQL 查詢的預設自動限制。

其他資源

  • 上次更新時間：