users-v2 命令组

注释

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

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

Databricksusers-v2 CLI 中的命令组允许你在 Databricks 工作区中管理用户标识。 Databricks 建议使用 SCIM 预配将用户和组从标识提供者自动同步到 Databricks 工作区。

databricks users-v2 create

在 Databricks 工作区中创建新用户。 此新用户还将添加到 Databricks 帐户。

databricks users-v2 create [flags]

Arguments

没有

选项

--active

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

--display-name string

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

--external-id string

    外部 ID。 当前不支持。

--id string

    Databricks 用户 ID。

--json JSON

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

--user-name string

    Databricks 用户的电子邮件地址。

全局标志

示例

以下示例创建一个新用户:

databricks users-v2 create --user-name "user@example.com" --display-name "Test User"

databricks users-v2 delete

删除用户。 从 Databricks 工作区中删除用户也会删除与用户关联的对象。

databricks users-v2 delete ID [flags]

Arguments

ID

    Databricks 工作区中用户的唯一 ID。

选项

全局标志

示例

以下示例删除用户:

databricks users-v2 delete 12345678

databricks users-v2 get

获取 Databricks 工作区中特定用户的信息。

databricks users-v2 get ID [flags]

Arguments

ID

    Databricks 工作区中用户的唯一 ID。

选项

--attributes string

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

--count int

    每个页面所需的结果数。

--excluded-attributes string

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

--filter string

    用于筛选结果的查询。

--sort-by string

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

--sort-order GetSortOrder

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

--start-index int

    指定第一个结果的索引。

全局标志

示例

以下示例获取用户详细信息:

databricks users-v2 get 12345678

databricks users-v2 列表

获取与 Databricks 工作区关联的所有用户的详细信息。

databricks users-v2 list [flags]

Arguments

没有

选项

--attributes string

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

--count int

    每个页面所需的结果数。

--excluded-attributes string

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

--filter string

    用于筛选结果的查询。

--sort-by string

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

--sort-order ListSortOrder

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

--start-index int

    指定第一个结果的索引。

全局标志

示例

以下示例列出所有用户:

databricks users-v2 list

以下示例列出与筛选器匹配的用户:

databricks users-v2 list --filter "userName sw \"admin\""

databricks users-v2 修补程序

通过将提供的操作应用于特定用户属性来部分性更新用户资源。

databricks users-v2 patch ID [flags]

Arguments

ID

    Databricks 工作区中的唯一 ID。

选项

--json JSON

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

全局标志

示例

以下示例使用 JSON 文件修补用户:

databricks users-v2 patch 12345678 --json @patch.json

databricks users-v2 更新

将用户的信息替换为请求中提供的数据。

databricks users-v2 update ID [flags]

Arguments

ID

    Databricks 用户 ID。

选项

--active

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

--display-name string

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

--external-id string

    外部 ID。 当前不支持。

--json JSON

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

--user-name string

    Databricks 用户的电子邮件地址。

全局标志

示例

以下示例更新用户:

databricks users-v2 update 12345678 --display-name "Test User"

databricks users-v2 get-permission-levels

获取用户可以对对象拥有的密码权限级别。

databricks users-v2 get-permission-levels [flags]

Arguments

没有

选项

全局标志

示例

以下示例获取密码权限级别:

databricks users-v2 get-permission-levels

databricks users-v2 get-permissions

获取所有密码的权限。 密码可以从其根对象继承权限。

databricks users-v2 get-permissions [flags]

Arguments

没有

选项

全局标志

示例

以下示例获取密码权限:

databricks users-v2 get-permissions

databricks users-v2 set-permissions

对对象设置密码权限,替换现有权限(如果存在)。 如果未指定任何权限,则删除所有直接权限。 对象可以从其根对象继承权限。

databricks users-v2 set-permissions [flags]

Arguments

没有

选项

--json JSON

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

全局标志

示例

以下示例使用 JSON 文件设置密码权限:

databricks users-v2 set-permissions --json @permissions.json

databricks users-v2 update-permissions

更新所有密码的权限。 密码可以从其根对象继承权限。

databricks users-v2 update-permissions [flags]

Arguments

没有

选项

--json JSON

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

全局标志

示例

以下示例使用 JSON 文件更新密码权限:

databricks users-v2 update-permissions --json @permissions.json

全局标志

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

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