注释
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明,包括任何数据使用规定。
service-principals
CLI 中的命令组允许你在 Databricks 工作区中管理服务主体。 请参阅 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 字符串或包含请求正文的 JSON 文件中的 @path。
例子
以下示例将创建一个具有显示名称的服务主体:
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]
论据
ID
Databricks 工作区中服务主体的唯一 ID。
选项
例子
以下示例按 ID 删除服务主体:
databricks service-principals delete 12345
databricks 服务主体获取
获取 Databricks 工作区中定义的单个服务主体的详细信息。
databricks service-principals get ID [flags]
论据
ID
Databricks 工作区中服务主体的唯一 ID。
选项
例子
以下示例获取服务主体的详细信息:
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
对结果进行排序的顺序。 支持的值:ascending
、descending
--start-index int
指定第一个结果的索引。
例子
以下示例列出所有服务主体:
databricks service-principals list
以下示例列出具有筛选的服务主体:
databricks service-principals list --filter "displayName eq 'My Service Principal'"
databricks 服务主体修补程序
部分更新 Databricks 工作区中单个服务主体的详细信息。
databricks service-principals patch ID [flags]
论据
ID
Databricks 工作区中的唯一 ID。
选项
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
例子
以下示例更新了服务主体:
databricks service-principals patch 12345 --json '{"display_name": "Updated Service Principal"}'
databricks 服务主体更新
更新单个服务主体的详细信息。 此操作将替换现有具有相同名称的服务主体。
databricks service-principals update ID [flags]
论据
ID
Databricks 服务主体 ID。
选项
--active
如果此用户处于活动状态。
--application-id string
与服务主体相关的 UUID。
--display-name string
表示给定名称和系列名称串联的字符串。
--external-id string
服务主体的外部 ID。
--id string
Databricks 服务主体 ID。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
例子
以下示例更新服务主体:
databricks service-principals update 12345 --display-name "Updated Service Principal" --active
全局标志
--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
字符串
如果适用,要使用的捆绑包目标