policies 命令组

Note

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

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

Databricks CLI1 中的 命令组允许你在 Unity 目录中管理 Attribute-Based 访问控制 (ABAC) 策略。 ABAC 为强制实施合规性策略提供了高杠杆治理。 使用 ABAC 策略时,基于数据属性而不是特定资源,以分层且可缩放的方式控制访问。 调用方必须有权 MANAGE 查看、创建、更新或删除 ABAC 策略的安全对象。

databricks 策略 create-policy

在安全对象上创建 ABAC 策略。 新策略适用于安全对象及其所有后代。

databricks policies create-policy TO_PRINCIPALS FOR_SECURABLE_TYPE POLICY_TYPE [flags]

参数

TO_PRINCIPALS

    策略适用的用户或组名称列表。

FOR_SECURABLE_TYPE

    策略应生效的安全对象类型。 支持的值:CATALOG、、、CONNECTIONSTAGING_TABLETABLESHARESTORAGE_CREDENTIALCLEAN_ROOMCREDENTIALEXTERNAL_LOCATIONEXTERNAL_METADATAFUNCTIONMETASTOREPIPELINEPROVIDERRECIPIENTSCHEMAVOLUME

POLICY_TYPE

    策略的类型。 支持的值:POLICY_TYPE_COLUMN_MASKPOLICY_TYPE_ROW_FILTER

选项

--comment string

    策略的可选说明。

--json JSON

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

--name string

    策略的名称。

--on-securable-fullname string

    定义策略的安全对象的完整名称。

--on-securable-type SecurableType

    定义策略的安全对象的类型。 支持的值:CATALOG、、、CONNECTIONSTAGING_TABLETABLESHARESTORAGE_CREDENTIALCLEAN_ROOMCREDENTIALEXTERNAL_LOCATIONEXTERNAL_METADATAFUNCTIONMETASTOREPIPELINEPROVIDERRECIPIENTSCHEMAVOLUME

--when-condition string

    策略生效时的可选条件。

全局标志

Examples

以下示例创建行筛选器策略:

databricks policies create-policy "data-engineers" TABLE POLICY_TYPE_ROW_FILTER --name "pii-filter" --on-securable-type TABLE --on-securable-fullname "main.default.customers"

databricks 策略 delete-policy

删除在安全对象上定义的 ABAC 策略。

databricks policies delete-policy ON_SECURABLE_TYPE ON_SECURABLE_FULLNAME NAME [flags]

参数

ON_SECURABLE_TYPE

    必填。 要从中删除策略的安全对象的类型。

ON_SECURABLE_FULLNAME

    必填。 要从中删除策略的安全对象的完全限定名称。

NAME

    必填。 要删除的策略的名称。

选项

全局标志

Examples

以下示例删除策略:

databricks policies delete-policy TABLE main.default.customers pii-filter

databricks 策略 get-policy

获取安全对象的策略定义。

databricks policies get-policy ON_SECURABLE_TYPE ON_SECURABLE_FULLNAME NAME [flags]

参数

ON_SECURABLE_TYPE

    必填。 要为其检索策略的安全对象的类型。

ON_SECURABLE_FULLNAME

    必填。 要为其检索策略的安全对象的完全限定名称。

NAME

    必填。 要检索的策略的名称。

选项

全局标志

Examples

以下示例获取策略:

databricks policies get-policy TABLE main.default.customers pii-filter

databricks 策略 list-policies

列出在安全对象上定义的所有策略。 (可选)该列表可以包括在安全对象的父架构或目录上定义的继承策略。

databricks policies list-policies ON_SECURABLE_TYPE ON_SECURABLE_FULLNAME [flags]

参数

ON_SECURABLE_TYPE

    必填。 要列出其策略的安全对象的类型。

ON_SECURABLE_FULLNAME

    必填。 要列出其策略的安全对象的完全限定名称。

选项

--include-inherited

    可选。 是否包括父安全对象的继承策略。

--max-results int

    可选。 要返回的最大结果数。

--page-token string

    可选。 上一个列表调用中的页令牌。

全局标志

Examples

以下示例列出表上的策略:

databricks policies list-policies TABLE main.default.customers

以下示例列出了包括继承策略的策略:

databricks policies list-policies TABLE main.default.customers --include-inherited

databricks 策略 update-policy

更新安全对象的 ABAC 策略。

databricks policies update-policy ON_SECURABLE_TYPE ON_SECURABLE_FULLNAME NAME TO_PRINCIPALS FOR_SECURABLE_TYPE POLICY_TYPE [flags]

参数

ON_SECURABLE_TYPE

    必填。 要为其更新策略的安全对象的类型。

ON_SECURABLE_FULLNAME

    必填。 要为其更新策略的安全对象的完全限定名称。

NAME

    必填。 要更新的策略的名称。

TO_PRINCIPALS

    策略适用的用户或组名称列表。

FOR_SECURABLE_TYPE

    策略应生效的安全对象类型。 支持的值:CATALOG、、、CONNECTIONSTAGING_TABLETABLESHARESTORAGE_CREDENTIALCLEAN_ROOMCREDENTIALEXTERNAL_LOCATIONEXTERNAL_METADATAFUNCTIONMETASTOREPIPELINEPROVIDERRECIPIENTSCHEMAVOLUME

POLICY_TYPE

    策略的类型。 支持的值:POLICY_TYPE_COLUMN_MASKPOLICY_TYPE_ROW_FILTER

选项

--comment string

    策略的可选说明。

--json JSON

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

--name string

    策略的名称。

--on-securable-fullname string

    定义策略的安全对象的完整名称。

--on-securable-type SecurableType

    定义策略的安全对象的类型。

--update-mask string

    可选。 用于指定要更新的字段的字段掩码。

--when-condition string

    策略生效时的可选条件。

全局标志

Examples

以下示例更新策略:

databricks policies update-policy TABLE main.default.customers pii-filter "data-engineers,data-scientists" TABLE POLICY_TYPE_ROW_FILTER

全局标志

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

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