service-principals 命令组

Note

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 The Databricks CLI is in Public Preview.

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The service-principals command group within the Databricks CLI allows you to manage service principals in your Databricks workspace. 请参阅 CI/CD 的服务主体

databricks 服务主体创建

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

databricks service-principals create [flags]

选项

--active

    如果此用户处于活动状态。

--application-id string

    与服务主体相关的 UUID。

--display-name string

    表示给定名称和系列名称串联的字符串。

--external-id string

    服务主体的外部 ID。

--id string

    Databricks 服务主体 ID。

--json JSON

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

Global flags

Examples

以下示例创建一个显示名称的服务主体:

databricks service-principals create --display-name "My Service Principal"

以下示例使用 JSON 创建服务主体:

databricks service-principals create --json '{"display_name": "My Service Principal", "active": true}'

databricks 服务主体删除

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

databricks service-principals delete ID [flags]

Arguments

ID

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

选项

Global flags

Examples

以下示例按 ID 删除服务主体:

databricks service-principals delete 12345

databricks 服务主体获取

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

databricks service-principals get ID [flags]

Arguments

ID

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

选项

Global flags

Examples

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

databricks service-principals get 12345

databricks 服务主体列表

列出与 Databricks 工作区关联的服务主体集。

databricks service-principals list [flags]

选项

--attributes string

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

--count int

    每个页面所需的结果数。

--excluded-attributes string

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

--filter string

    查询必须筛选结果。

--sort-by string

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

--sort-order ListSortOrder

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

--start-index int

    指定第一个结果的索引。

Global flags

Examples

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

databricks service-principals list

以下示例列出具有筛选的服务主体:

databricks service-principals list --filter "displayName eq 'My Service Principal'"

databricks 服务主体修补程序

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

databricks service-principals patch ID [flags]

Arguments

ID

    Databricks 工作区中的唯一 ID。

选项

--json JSON

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

Global flags

Examples

以下示例修补了服务主体:

databricks service-principals patch 12345 --json '{"display_name": "Updated Service Principal"}'

databricks 服务主体更新

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

databricks service-principals update ID [flags]

Arguments

ID

    Databricks 服务主体 ID。

选项

--active

    如果此用户处于活动状态。

--application-id string

    与服务主体相关的 UUID。

--display-name string

    表示给定名称和系列名称串联的字符串。

--external-id string

    服务主体的外部 ID。

--id string

    Databricks 服务主体 ID。

--json JSON

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

Global flags

Examples

以下示例更新服务主体:

databricks service-principals update 12345 --display-name "Updated Service Principal" --active

Global flags

--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 字符串

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