设置 API 密钥参考

本页列出了通过公共 Azure Databricks 设置 API 提供的设置，按范围分组。 每个设置都通过稳定 的设置名称 （密钥）来标识。 关于如何发现、阅读和更新这些设置，请参见 通过设置API管理设置。

功能预览也通过设置API管理，但这里未列出，因为它们是短暂的，最终会终止生命。 通过 设置-元数据端点发现当前可用的预览版本。

可用设置

以下设置可通过公开设置API按范围分组使用。 该列表会定期生成;对于权威且始终最新的设置集及其文档链接，调用 settings-metadata 端点，返回每个设置的 name、 description、 typedocs_link和 。

帐户设置

适用于整个账户的设置。

设置 密钥名称 Description
禁用遗留功能 disable_legacy_features 禁用新Databricks工作区的遗留功能。 对于新创建的工作区：1. 禁用DBFS根和挂载的使用。 2. Hive Metastore 不会被配置。 3. 禁用“无隔离集群”的使用。 4. 禁用13.3LTS之前的Databricks运行时版本。
限制工作区管理员 restrict_workspace_admins “限制工作区管理员”设置允许你控制工作区管理员的功能。 设置状态设置为ALLOW_ALL后，工作区管理员可以代表工作区内的任何服务主体创建服务主体个人访问令牌。 工作区管理员还可以将作业所有者更改为工作区中的任何用户。 他们还可以将工作run_as设置更改为工作空间内的任何用户，或是拥有服务主用户角色的服务主体。 设置状态设为RESTRICT_TOKENS_AND_JOB_RUN_AS后，工作区管理员只能代表他们拥有服务主体用户角色的服务主体创建个人访问令牌。 他们也只能将作业所有者更改为自己。 他们可以将工作run_as设置更改为自己，或更改为拥有服务主用户角色的服务主体。

工作区设置

适用于单一工作区的设置。

设置 密钥名称 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时，已批准的域名列表无法变更。
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的root和DBFS挂载（以及创建新的挂载）。 2. 禁用13.3LTS之前的Databricks运行时版本。 关闭该设置时，所有DBFS功能都被启用，且对Databrick的运行时版本不施加任何限制。 该设置可能需要长达20分钟才能生效，并且需要手动重启多功能计算集群和SQL仓库。
限制工作区管理员 restrict_workspace_admins “限制工作区管理员”设置允许你控制工作区管理员的功能。 设置状态设置为ALLOW_ALL后，工作区管理员可以代表工作区内的任何服务主体创建服务主体个人访问令牌。 工作区管理员还可以将作业所有者更改为工作区中的任何用户。 他们还可以将工作run_as设置更改为工作空间内的任何用户，或是拥有服务主用户角色的服务主体。 设置状态设为RESTRICT_TOKENS_AND_JOB_RUN_AS后，工作区管理员只能代表他们拥有服务主体用户角色的服务主体创建个人访问令牌。 他们也只能将作业所有者更改为自己。 他们可以将工作run_as设置更改为自己，或更改为拥有服务主用户角色的服务主体。
工作区标签 workspace_label 在Databricks控制台顶部导航中，工作区名称旁边会显示一个自定义标签和颜色徽章。 工作区管理员可以使用此设置在不同环境中可视化区分工作区。 该值是一个对象，包含一个label字段（文本字符串）和一个color字段（其中一个：coral， turquoiselimeindigolemonpurple， ， ）。 pink 当没有设置标签时，这两个字段都是空字符串。

用户首选项

适用于账户用户的设置。

设置 密钥名称 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-Dark， BlackboardDracula， GitHub-Dark， MonokaiOne-Dark-Pro， ， ， 。 Winter-is-Coming-Dark
编辑器自定义光源主题 editorCustomLightTheme 控制编辑器的自定义光源主题。 允许的值：defaultTheme、、、Active4DAtom-One-Light、Ayu-LightGitHub-Light、TomorrowWinter-is-Coming-Light。
编辑器字体大小 editorFontSize 控制编辑器中的字体大小。 允许的值：整数范围为10到30。
启用自动内联快速修复 enableAutoInlineQuickFix 控制是否会自动推荐内联快速修复方案。
启用自动内联快速修复 选择退出 enableAutoInlineQuickFixOptOut 自动在线快速修复的选择退出控制。
启用自动触发诊断 enableAutoTriggerDiagnose 控制诊断是否自动触发。
启用自动触发诊断 选择退出 enableAutoTriggerDiagnoseOptOut 自动诊断的选择退出控制。
启用居中布局 enableCenteredLayout 控制编辑器是否使用居中布局。
启用经典快捷键 enableClassicShortcuts 控制键盘快捷键模式。 允许的值：default、classic。
启用命令编号 enableCommandNumbers 控制命令编号是否显示在笔记本中。
在输入时启用补全 enableCompletionsAsYouType 控制你输入时自动补全建议是否会出现。
启用光标闪烁 enableCursorBlink 控制编辑器中光标是否闪烁。
启用暗黑模式 enableDarkMode 控制主题模式。 允许的值：light、dark、system。
启用 Enter 接受建议 enableEnterAcceptsSuggestions 控制按回车是否接受自动补全建议。
启用编辑器悬停 enableHoverForEditor 控制编辑器中是否显示悬停工具提示。
在输入时启用内联建议，选择退出 enableInlineSuggestionAsYouTypeOptOut 输入时的内嵌建议可选择退出。
启用行号 enableLineNumbers 控制编辑器中是否显示行号。
启用线号V2 enableLineNumbersV2 控制编辑器（v2）中是否显示行号。
启用线环 enableLineWrap 控制编辑器中文本是否换行到下一行。
启用摩纳哥多光标 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 控制是否显示扩展的底部面板。
湖流新管道监测界面 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语法错误高亮的opt-out控制。
用户激活 Python 类型检查 userActivatesPythonTypeChecking 控制是否启用 Python 类型检查。
用户激活快照恢复 userActivatesSnapshotRestore 控制是否启用快照恢复功能。
新查询默认限制为1000 usqleDefaultQueryAutoLimit 控制编辑器中SQL查询的默认自动限制。

其他资源

  • Last updated on