service-principals-v2 命令组

注意事项

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

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

service-principals-v2 CLI 中的命令组允许你管理服务主体标识,以便与作业、自动化工具和系统(如脚本、应用和 CI/CD 平台)配合使用。 Databricks 建议创建服务主体来运行生产作业或修改生产数据。

databricks service-principals-v2 create

在 Databricks 工作区中创建新的服务主体。

databricks service-principals-v2 create [flags]

参数

None

选项

--active

    如果此服务主体处于活动状态。

--application-id string

    与服务主体相关的 UUID。

--display-name string

    表示名字和姓氏拼接的字符串。

--external-id string

    服务主体的外部 ID。

--id string

    Databricks 服务主体 ID。

--json JSON

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

全局标志

示例

以下示例创建新的服务主体:

databricks service-principals-v2 create --display-name "my-service-principal"

databricks service-principals-v2 delete

从 Databricks 工作区中删除单个服务主体。

databricks service-principals-v2 delete ID [flags]

参数

ID

    Databricks 工作区中服务主体的唯一 ID。

选项

全局标志

示例

以下示例删除服务主体:

databricks service-principals-v2 delete 12345678

databricks service-principals-v2 get

获取 Databricks 工作区中定义的单个服务主体的详细信息。

databricks service-principals-v2 get ID [flags]

参数

ID

    Databricks 工作区中服务主体的唯一 ID。

选项

全局标志

示例

以下示例获取服务主体详细信息:

databricks service-principals-v2 get 12345678

databricks service-principals-v2 列表

获取与 Databricks 工作区关联的服务主体集。

databricks service-principals-v2 list [flags]

参数

None

选项

--attributes string

    响应中返回的属性列表,用逗号分隔。

--count int

    每个页面所需的结果数。

--excluded-attributes string

    响应时需要排除的属性的逗号分隔列表。

--filter string

    用于筛选结果的查询。

--sort-by string

    用于对结果进行排序的属性。

--sort-order ListSortOrder

    对结果进行排序的顺序。 支持的值:ascendingdescending

--start-index int

    指定第一个结果的索引。

全局标志

示例

以下示例列出所有服务主体:

databricks service-principals-v2 list

databricks service-principals-v2 修补程序

部分更新 Databricks 工作区中单个服务主体的详细信息。

databricks service-principals-v2 patch ID [flags]

参数

ID

    Databricks 工作区中的唯一 ID。

选项

--json JSON

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

全局标志

示例

以下示例使用 JSON 文件修补服务主体:

databricks service-principals-v2 patch 12345678 --json @patch.json

databricks service-principals-v2 更新

更新单个服务主体的详细信息。 此操作将替换现有具有相同名称的服务主体。

databricks service-principals-v2 update ID [flags]

参数

ID

    Databricks 服务主体 ID。

选项

--active

    如果此服务主体处于活动状态。

--application-id string

    与服务主体相关的 UUID。

--display-name string

    表示名字和姓氏拼接的字符串。

--external-id string

    服务主体的外部 ID。

--json JSON

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

全局标志

示例

以下示例更新服务主体的显示名称:

databricks service-principals-v2 update 12345678 --display-name "updated-service-principal"

全局标志

--debug

  是否启用调试日志记录。

-h--help

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

--log-file 字符串

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

--log-format 格式

    日志格式类型,textjson。 默认值为 text.

--log-level 字符串

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

-o, --output 类型

    命令输出类型为 textjson。 默认值为 text.

-p, --profile 字符串

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

--progress-format 格式

    显示进度日志的格式: defaultappendinplacejson

-t, --target 字符串

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