注释
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明,包括任何数据使用规定。
recipient-federation-policies
Databricks CLI 中的命令组包含用于管理开放共享模型中 OIDC 收件人的联合策略的命令。 这些命令仅适用于收件人对象具有身份验证类型的OIDC_RECIPIENT,从而启用从 Databricks 到非 Databricks 收件人的数据共享。 请参阅使用 Open ID Connect (OIDC) 联合身份验证启用对 Delta Sharing 共享(开放共享)的身份验证。
databricks recipient-federation-policies create
为OIDC_FEDERATION收件人创建联合策略,以便将数据从 Databricks 共享到非 Databricks 收件人。 呼叫方必须是收件人的所有者。
将数据从 Databricks 共享到非 Databricks 客户端时,可以定义联合策略以对非 Databricks 收件人进行身份验证。 联合策略在联合令牌中验证 OIDC 声明,并在收件人级别定义。 这使无机密共享客户端能够使用 OIDC 令牌进行身份验证。
联合策略支持的方案:
- 用户到计算机(U2M)流( 例如 PowerBI):用户使用自己的标识访问资源。
- 计算机到计算机(M2M)流( 例如 OAuth 应用):OAuth 应用使用自己的标识访问资源,通常用于运行夜间作业等任务。
有关基于用例的详细配置指南,请参阅:
databricks recipient-federation-policies create RECIPIENT_NAME [flags]
Arguments
RECIPIENT_NAME
收件人的名称。 这是要为其创建策略的收件人的名称。
选项
--comment string
策略的说明。
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件
--name string
联合策略的名称。
示例
以下示例为收件人创建联合策略:
databricks recipient-federation-policies create my_recipient --name "my_policy" --comment "Policy for PowerBI users"
以下示例使用 JSON 创建联合策略:
databricks recipient-federation-policies create my_recipient --json '{"name": "m2m_policy", "comment": "Policy for automated jobs", "claims": [{"key": "aud", "value": "my-app-id"}]}'
以下示例使用 JSON 文件创建联合策略:
databricks recipient-federation-policies create my_recipient --json @federation-policy.json
databricks recipient-federation-policies delete
删除OIDC_FEDERATION收件人的现有联合策略。 呼叫方必须是收件人的所有者。
databricks recipient-federation-policies delete RECIPIENT_NAME NAME [flags]
Arguments
RECIPIENT_NAME
收件人的名称。 这是要为其删除策略的收件人的名称。
NAME
策略的名称。 这是要删除的策略的名称。
选项
示例
以下示例删除联合策略:
databricks recipient-federation-policies delete my_recipient my_policy
databricks recipient-federation-policies get-federation-policy
获取OIDC_FEDERATION收件人的现有联合策略,以便将数据从 Databricks 共享到非 Databricks 收件人。 呼叫方必须具有对收件人的读取访问权限。
databricks recipient-federation-policies get-federation-policy RECIPIENT_NAME NAME [flags]
Arguments
RECIPIENT_NAME
收件人的名称。 这是要为其检索策略的收件人的名称。
NAME
策略的名称。 这是要检索的策略的名称。
选项
示例
以下示例获取联合策略:
databricks recipient-federation-policies get-federation-policy my_recipient my_policy
databricks recipient-federation-policies 列表
列出OIDC_FEDERATION收件人的联合策略,以便将数据从 Databricks 共享到非 Databricks 收件人。 呼叫方必须具有对收件人的读取访问权限。
databricks recipient-federation-policies list RECIPIENT_NAME [flags]
Arguments
RECIPIENT_NAME
收件人的名称。 这是要为其列出策略的收件人的名称。
选项
--max-results int
每个页面要返回的最大策略数。
--page-token string
用于检索下一页结果的令牌。
示例
以下示例列出收件人的所有联合策略:
databricks recipient-federation-policies list my_recipient
以下示例列出了使用分页的联合策略:
databricks recipient-federation-policies list my_recipient --max-results 10
全局标志
--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 字符串
如果适用,要使用的捆绑包目标