共用方式為

users 命令组

注释

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

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

users CLI 中的命令组允许你在 Databricks 工作区中管理用户标识。 Databricks 识别的用户标识由电子邮件地址表示。 请参阅管理用户

databricks 用户创建

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

databricks users create [flags]

选项

--active

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

--display-name string

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

--external-id string

    当前不支持外部 ID。

--id string

    Databricks 用户 ID。

--json JSON

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

--user-name string

    Databricks 用户的电子邮件地址。

全局标志

例子

以下示例使用显示名称和电子邮件创建用户:

databricks users create --display-name "John Doe" --user-name "someone@example.com"

以下示例使用 JSON 创建用户:

databricks users create --json '{"display_name": "John Doe", "user_name": "someone@example.com", "active": true}'

databricks 用户删除

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

databricks users delete ID [flags]

论据

ID

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

选项

全局标志

例子

以下示例按 ID 删除用户:

databricks users delete 12345

databricks 的用户可以获得

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

databricks users get ID [flags]

论据

ID

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

选项

--attributes string

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

--count int

    每个页面所需的结果数。

--excluded-attributes string

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

--filter string

    用于筛选结果的查询。

--sort-by string

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

--sort-order GetSortOrder

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

--start-index int

    指定第一个结果的索引。

全局标志

例子

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

databricks users get 12345

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

databricks users get 12345 --output json

databricks 用户列表

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

databricks users list [flags]

选项

--attributes string

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

--count int

    每个页面所需的结果数。

--excluded-attributes string

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

--filter string

    用于筛选结果的查询。

--sort-by string

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

--sort-order ListSortOrder

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

--start-index int

    指定第一个结果的索引。

全局标志

例子

以下示例列出所有用户:

databricks users list

以下示例列出经过筛选的用户:

databricks users list --filter "userName eq 'someone@example.com'"

以下示例列出具有分页的用户:

databricks users list --count 10 --start-index 0

Databricks 用户补丁

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

databricks users patch ID [flags]

论据

ID

    Databricks 工作区中的唯一 ID。

选项

--json JSON

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

全局标志

例子

以下示例更新用户:

databricks users patch 12345 --json '{"display_name": "Jane Doe"}'

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

databricks users patch 12345 --json @update.json

databricks 用户更新

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

databricks users update ID [flags]

论据

ID

    Databricks 用户 ID。

选项

--active

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

--display-name string

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

--external-id string

    当前不支持外部 ID。

--id string

    Databricks 用户 ID。

--json JSON

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

--user-name string

    Databricks 用户的电子邮件地址。

全局标志

例子

以下示例更新用户:

databricks users update 12345 --display-name "Jane Doe" --user-name "new-someone@example.com" --active

以下示例使用 JSON 更新用户:

databricks users update 12345 --json '{"display_name": "Jane Doe", "user_name": "new-someone@example.com", "active": true}'

databricks 用户 获取权限级别

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

databricks users get-permission-levels [flags]

选项

全局标志

例子

以下示例展示如何获取用户的权限级别:

databricks users get-permission-levels

以下示例获取 JSON 格式的权限级别:

databricks users get-permission-levels --output json

databricks 用户获取权限

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

databricks users get-permissions [flags]

选项

全局标志

例子

以下示例获取用户的权限:

databricks users get-permissions

以下示例获取 JSON 格式的权限:

databricks users get-permissions --output json

databricks 用户设置权限

设置密码权限。

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

databricks users set-permissions [flags]

选项

--json JSON

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

全局标志

例子

以下示例使用 JSON 设置权限:

databricks users set-permissions --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'

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

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

databricks 用户更新权限

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

databricks users update-permissions [flags]

选项

--json JSON

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

全局标志

例子

以下示例使用 JSON 更新权限:

databricks users update-permissions --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'

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

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

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