rfa 命令组

注释

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

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

rfa Databricks CLI 中的“请求访问”命令组包含用于允许用户请求 Unity 目录安全对象的访问的命令。 这些命令为安全对象所有者(或具有 MANAGE 特权的用户)管理访问请求目标提供了标准化的方法。

databricks rfa batch-create-access-requests

为安全对象上的指定主体创建 Unity 目录权限的访问请求。 此 Batch API 可以采用多个主体、安全对象和权限作为输入,并返回每个主体的访问请求目标。 主体在 API 调用中必须是唯一的。

受支持的安全对象类型包括:metastore、、catalogschematableexternal_locationconnectioncredentialfunctionregistered_modelvolume

databricks rfa batch-create-access-requests [flags]

选项

--json JSON

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

全局标志

示例

以下示例使用 JSON 创建多个访问请求:

databricks rfa batch-create-access-requests --json '{"requests": [{"principal": "user@example.com", "securable_type": "catalog", "securable_full_name": "my_catalog", "permissions": ["USE_CATALOG", "USE_SCHEMA"]}]}'

以下示例使用 JSON 文件创建访问请求:

databricks rfa batch-create-access-requests --json @access-requests.json

databricks rfa get-access-request-destinations

获取指定安全对象的访问请求目标。 任何调用方都可以查看元存储上的 URL 目标或目标。 否则,只有对安全对象具有 BROWSE 权限的用户才能看到目标。

受支持的安全对象类型包括:metastore、、catalogschematableexternal_locationconnectioncredentialfunctionregistered_modelvolume

databricks rfa get-access-request-destinations SECURABLE_TYPE FULL_NAME [flags]

Arguments

SECURABLE_TYPE

    安全对象的类型。

FULL_NAME

    安全对象的全名。

选项

全局标志

示例

以下示例获取目录的访问请求目标:

databricks rfa get-access-request-destinations catalog my_catalog

以下示例获取表的访问请求目标:

databricks rfa get-access-request-destinations table my_catalog.my_schema.my_table

databricks rfa update-access-request-destinations

更新给定安全对象的访问请求目标。 调用方必须是元存储管理员、安全对象的所有者或对安全对象具有 MANAGE 权限的用户才能分配目标。

不能针对架构下的安全对象(表、卷、函数和模型)更新目标。 对于这些安全对象类型,目标继承自父安全对象。 最多可以向安全对象分配 5 封电子邮件和 5 个外部通知目标(Slack、Microsoft Teams 和通用 Webhook 目标)。 如果分配了 URL 目标,则无法设置其他目标。

受支持的安全对象类型包括:metastore、、catalogschematableexternal_locationconnectioncredentialfunctionregistered_modelvolume

databricks rfa update-access-request-destinations UPDATE_MASK SECURABLE [flags]

Arguments

UPDATE_MASK

    字段掩码必须是单个字符串,多个字段用逗号分隔(无空格)。 字段路径是相对于资源对象而言的,通过点(.)来导航子字段(例如,author.given_name)。 不允许对序列或映射字段中的元素进行规范,因为只能指定整个集合字段。 字段名称必须与资源字段名称完全匹配。

    星号 (*) 字段掩码指示完全替换。 建议始终显式列出要更新的字段,避免使用通配符,因为如果 API 将来发生更改,可能会导致意外结果。

SECURABLE

    要为其修改或读取访问请求目标的安全对象。

选项

--json JSON

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

全局标志

示例

以下示例使用 JSON 更新目录的访问请求目标:

databricks rfa update-access-request-destinations "destinations" catalog:my_catalog --json '{"destinations": [{"email": "admin@example.com"}]}'

以下示例使用 JSON 文件更新访问请求目标:

databricks rfa update-access-request-destinations "destinations" catalog:my_catalog --json @destinations.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 字符串

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