共用方式為

settings 命令组

注释

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。

Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明，包括任何数据使用规定。

settings Databricks CLI 中的命令组包含用于管理工作区级别设置的命令，这些设置控制整个工作区中应用的各种功能和策略。 请参阅管理工作区。

Databricks 配置 aibi-仪表板嵌入访问策略

控制是否在工作区级别启用、有条件启用或禁用由 AI/BI 发布的仪表板嵌入。 默认情况下，此设置是有条件启用的（ALLOW_APPROVED_DOMAINS）。

  • delete - 删除 AI/BI 仪表板嵌入访问策略
  • get - 检索 AI/BI 仪表板嵌入访问策略
  • update - 更新 AI/BI 仪表板嵌入访问策略

databricks 设置 aibi-dashboard-embedding-access-policy 获取

检索 AI/BI 仪表板的嵌入访问策略。 默认设置是 ALLOW_APPROVED_DOMAINS允许将 AI/BI 仪表板嵌入到已批准的域中。

databricks settings aibi-dashboard-embedding-access-policy get [flags]

选项

--etag string

    用于版本控制的 etag。

全局标志

例子

databricks settings aibi-dashboard-embedding-access-policy get

Databricks 设置 aibi-dashboard-embedding-access-policy 的更新

在工作区级别更新 AI/BI 仪表板的嵌入式访问策略。

databricks settings aibi-dashboard-embedding-access-policy update [flags]

选项

--json JSON

    内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。

全局标志

例子

databricks settings aibi-dashboard-embedding-access-policy update --json '{"access_policy": "ALLOW_ALL"}'

databricks 设置 aibi-dashboard-embedding-access-policy delete

删除 AI/BI 仪表板嵌入访问策略，恢复为默认值。

databricks settings aibi-dashboard-embedding-access-policy delete [flags]

选项

--etag string

    用于版本控制的 etag。

全局标志

例子

databricks settings aibi-dashboard-embedding-access-policy delete

databricks 配置 aibi-dashboard-embedding-approved-domains

控制已批准托管嵌入式 AI/BI 仪表板的域列表。 当当前访问策略未设置为 ALLOW_APPROVED_DOMAINS时，无法改变已批准的域列表。

  • delete - 删除 AI/BI 仪表板嵌入已批准的域
  • get - 检索已批准托管嵌入式 AI/BI 仪表板的域列表
  • update - 更新已批准托管嵌入式 AI/BI 仪表板的域列表

选项

全局标志

例子

databricks settings aibi-dashboard-embedding-approved-domains get

databricks settings aibi-dashboard-embedding-approved-domains update --json '{"approved_domains": ["example.com", "mydomain.org"]}'

databricks 设置自动集群更新

控制是否为当前工作区启用自动群集更新。 默认情况下，它处于关闭状态。

  • get - 获取自动群集更新设置
  • update - 更新自动群集更新设置

选项

全局标志

databricks 设置 获取自动集群更新

获取自动群集更新设置。

databricks settings automatic-cluster-update get [flags]

选项

--etag string

    用于版本控制的 etag。

全局标志

例子

databricks settings automatic-cluster-update get

databricks 设置自动群集更新

更新工作区的自动群集更新设置。 更新请求中需要提供一个新的 etag（作为设置字段的一部分）。 可以通过在更新请求之前发出 get 请求来检索 etag。

databricks settings automatic-cluster-update update [flags]

选项

--json JSON

    内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。

全局标志

例子

databricks settings automatic-cluster-update update --json '{"automatic_cluster_update": {"enabled": true}}'

databricks 配置 compliance-security-profile

控制是否启用当前工作区的合规安全配置文件。 在工作区启用它后，将是永久性的。 默认情况下，它处于关闭状态。

警告

启用此设置后，无法禁用此设置。

  • get - 获取符合性安全配置文件设置
  • update - 更新合规安全配置文件设置

选项

全局标志

例子

databricks settings compliance-security-profile get

databricks settings compliance-security-profile update --json '{"compliance_security_profile": {"enabled": true}}'

databricks 设置仪表板-电子邮件订阅

控制工作区中刷新 AI/BI 仪表板的计划或工作负荷任务是否可以发送包含 PDF 和/或仪表板图像的订阅电子邮件。 默认情况下，此设置处于启用状态（设置为 true）。

  • delete - 删除仪表板电子邮件订阅设置
  • get - 获取仪表板电子邮件订阅设置
  • update - 更新仪表板电子邮件订阅设置

选项

全局标志

例子

databricks settings dashboard-email-subscriptions get

databricks settings dashboard-email-subscriptions update --json '{"dashboard_email_subscriptions": {"enabled": false}}'

databricks 设置默认命名空间

为 Databricks 工作区配置默认命名空间。

通过此命令，用户可以检索、设置或修改查询未引用完全限定的三级名称时使用的默认命名空间。 例如，如果使用 API 设置为 retail_prod 默认目录，则查询 SELECT * FROM myTable 将引用对象 retail_prod.default.myTable （始终假定架构 default ）。

注释

此设置需要重启群集和 SQL 仓库才能生效。 此外，默认命名空间仅在使用启用了 Unity 目录的计算时适用。

  • delete - 删除默认命名空间设置
  • get - 获取默认命名空间设置
  • update - 更新默认命名空间设置

选项

全局标志

例子

databricks settings default-namespace get

databricks settings default-namespace update --json '{"namespace": {"value": "retail_prod"}}'

databricks settings default-namespace delete

databricks 设置禁用旧版访问权限

禁用传统访问权限将产生以下影响：

  • 禁用从工作区直接访问 Hive 元存储。 但是，仍可以通过 Hive 元存储联合访问 Hive 元存储。

  • 禁用从工作区进行外部位置访问的回退模式。

  • 禁用 13.3 LTS 之前的 Databricks Runtime 版本。

  • delete - 删除旧版访问禁用状态

  • get - 检索旧版访问禁用状态

  • update - 更新遗留访问禁用状态

选项

全局标志

例子

databricks settings disable-legacy-access get

databricks settings disable-legacy-access update --json '{"disable_legacy_access": {"disabled": true}}'

databricks 设置 enable-export-notebook

控制用户是否可以从工作区 UI 导出笔记本和文件。 此设置默认已启用。

  • get-enable-export-notebook - 获取笔记本和文件导出设置
  • patch-enable-export-notebook - 更新笔记本和文件导出设置

选项

全局标志

例子

databricks settings enable-export-notebook get-enable-export-notebook

databricks settings enable-export-notebook patch-enable-export-notebook --json '{"allow_missing": true, "setting": {"enabled": false}}'

databricks 设置 “enable-notebook-table-clipboard”

控制用户是否可以通过 UI 将表格数据复制到剪贴板。 此设置默认已启用。

  • get-enable-notebook-table-clipboard - 获取结果表剪贴板功能设置
  • patch-enable-notebook-table-clipboard - 更新结果表剪贴板功能设置

选项

全局标志

例子

databricks settings enable-notebook-table-clipboard get-enable-notebook-table-clipboard

databricks settings enable-notebook-table-clipboard patch-enable-notebook-table-clipboard --json '{"allow_missing": true, "setting": {"enabled": false}}'

databricks 设置启用结果下载功能

控制用户是否可以下载笔记本结果。 此设置默认已启用。

  • get-enable-results-downloading - 获取笔记本结果下载设置
  • patch-enable-results-downloading - 更新笔记本结果下载设置

选项

全局标志

例子

databricks settings enable-results-downloading get-enable-results-downloading

databricks settings enable-results-downloading patch-enable-results-downloading --json '{"allow_missing": true, "setting": {"enabled": false}}'

databricks 设置增强的安全监视

控制是否为当前工作区启用了增强的安全监视。 如果启用了合规性安全配置文件，则会自动启用该配置文件。 默认情况下，它处于禁用状态。 但是，如果启用了符合性安全配置文件，该功能会自动启用。

如果关闭了合规性安全配置文件，则可以启用或禁用此设置，且此设置不是永久性的。

  • get - 获取增强的安全监视设置
  • update - 更新增强的安全监视设置

选项

全局标志

例子

databricks settings enhanced-security-monitoring get

databricks settings enhanced-security-monitoring update --json '{"enhanced_security_monitoring": {"enabled": true}}'

databricks 设置限制工作区管理员

“限制工作区管理员”设置允许你控制工作区管理员的功能。 当设置状态设为ALLOW_ALL时，工作区管理员可以代表其工作区中的任何服务主体创建服务主体个人访问令牌。 工作区管理员还可以将作业所有者更改为工作区中的任何用户。 他们可以将作业 run_as 设置更改为工作区中的任何用户或具有服务主体用户角色的服务主体。

将设置状态设为RESTRICT_TOKENS_AND_JOB_RUN_AS后，工作区管理员只能代表他们拥有服务主体用户角色的服务主体创建个人访问令牌。 他们只能将作业所有者更改为自己。 他们可以将作业 run_as 设置更改为自己，也可以更改为具有服务主体用户角色的服务主体。

  • delete - 删除限制工作区管理员设置
  • get - 获取限制工作区管理员设置
  • update - 更新限制工作区管理员设置

选项

全局标志

例子

databricks settings restrict-workspace-admins get

databricks settings restrict-workspace-admins update --json '{"restrict_workspace_admins": {"status": "RESTRICT_TOKENS_AND_JOB_RUN_AS"}}'

databricks settings restrict-workspace-admins delete

Databricks 设置 SQL 结果下载

控制是否允许工作区中的用户从 SQL 编辑器和 AI/BI 仪表板 UI 下载结果。 默认情况下，此设置处于启用状态（设置为 true）。

  • delete - 删除 SQL 结果下载设置
  • get - 获取 SQL 结果下载设置
  • update - 更新 SQL 结果下载设置

选项

全局标志

例子

databricks settings sql-results-download get

databricks settings sql-results-download update --json '{"sql_results_download": {"enabled": false}}'

databricks settings sql-results-download delete

全局标志

--debug

  是否启用调试日志记录。

-h 或 --help

    显示 Databricks CLI、相关命令组或相关命令的帮助。

--log-file 字符串

    一个字符串，表示要将输出日志写入到的文件。 如果未指定此标志，则默认会将输出日志写入到 stderr。

--log-format 格式

    日志格式类型，text 或 json。 默认值是 text。

--log-level 字符串

    一个表示日志格式级别的字符串。 如果未指定，则禁用日志格式级别。

-o, --output 类型

    命令输出类型为 text 或 json。 默认值是 text。

-p, --profile 字符串

    要用于运行命令的 ~/.databrickscfg 文件中的配置文件名称。 如果未指定此标志，并且存在命名为 DEFAULT 的配置文件，则使用该配置文件。

--progress-format 格式

    显示进度日志的格式： default、 append、 inplace或 json

-t, --target 字符串

    如果适用，要使用的捆绑包目标