注释
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明，包括任何数据使用规定。
entity-tag-assignments
Databricks CLI 中的命令组包含用于跨 Unity 目录实体创建、更新、删除和列出标记分配的命令。 标记是一些属性，包括可用于组织和分类 Unity 目录中实体的键和可选值。 请参阅“将标记应用于 Unity Catalog 安全对象”。
databricks entity-tag-assignments create
为 Unity 目录实体创建标记分配。
若要将标记添加到 Unity 目录实体，必须拥有该实体或具有以下权限：
- 对实体应用标记
- USE SCHEMA 在实体的父架构上
- USE CATALOG 实体的父目录
若要将受管理标记添加到 Unity 目录实体，还必须对标记策略具有 ASSIGN 或 MANAGE 权限。 请参阅 “管理标记策略权限”。
databricks entity-tag-assignments create ENTITY_NAME TAG_KEY ENTITY_TYPE [flags]
Arguments
ENTITY_NAME
为其分配标记的实体的完全限定名称。
TAG_KEY
标记的键。
ENTITY_TYPE
为其分配标记的实体的类型。 允许的值为：catalogs、、schemas、tablescolumns、 volumes。
选项
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件
--tag-value string
标记的值。
例子
以下示例为表创建标记分配：
databricks entity-tag-assignments create my_catalog.my_schema.my_table environment tables --tag-value production
以下示例使用 JSON 创建标记分配：
databricks entity-tag-assignments create my_catalog.my_schema.my_table department tables --json '{"tag_value": "finance"}'
databricks entity-tag-assignments delete
按其键删除 Unity 目录实体的标记分配。
若要从 Unity 目录实体中删除标记，必须拥有该实体或具有以下权限：
- 对实体应用标记
- 对实体的父架构USE_SCHEMA
- 实体父目录上的USE_CATALOG
若要从 Unity 目录实体中删除受管理标记，还必须对标记策略具有 ASSIGN 或 MANAGE 权限。 请参阅 “管理标记策略权限”。
databricks entity-tag-assignments delete ENTITY_TYPE ENTITY_NAME TAG_KEY [flags]
Arguments
ENTITY_TYPE
为其分配标记的实体的类型。 允许的值为：catalogs、、schemas、tablescolumns、 volumes。
ENTITY_NAME
为其分配标记的实体的完全限定名称。
TAG_KEY
要删除的标记的键。
选项
例子
以下示例从表中删除标记分配：
databricks entity-tag-assignments delete tables my_catalog.my_schema.my_table environment
databricks entity-tag-assignments get
按标记键获取 Unity 目录实体的标记分配。
databricks entity-tag-assignments get ENTITY_TYPE ENTITY_NAME TAG_KEY [flags]
Arguments
ENTITY_TYPE
为其分配标记的实体的类型。 允许的值为：catalogs、、schemas、tablescolumns、 volumes。
ENTITY_NAME
为其分配标记的实体的完全限定名称。
TAG_KEY
标记的键。
选项
例子
以下示例获取表的标记分配：
databricks entity-tag-assignments get tables my_catalog.my_schema.my_table environment
databricks entity-tag-assignments 列表
列出 Unity 目录实体的标记分配。
重要
API 默认为分页，页面可能包含零结果，同时仍提供next_page_token。 客户端必须继续阅读页面，直到next_page_token不存在，这是唯一指示已到达结果结束的指示。
databricks entity-tag-assignments list ENTITY_TYPE ENTITY_NAME [flags]
Arguments
ENTITY_TYPE
为其分配标记的实体的类型。 允许的值为：catalogs、、schemas、tablescolumns、 volumes。
ENTITY_NAME
为其分配标记的实体的完全限定名称。
选项
--max-results int
要返回的最大结果数。
--page-token string
用于检索下一页结果的令牌。
例子
以下示例列出表的所有标记分配：
databricks entity-tag-assignments list tables my_catalog.my_schema.my_table
以下示例列出具有分页的标记分配：
databricks entity-tag-assignments list tables my_catalog.my_schema.my_table --max-results 10
databricks entity-tag-assignments update
更新 Unity 目录实体的现有标记分配。
若要将标记更新到 Unity 目录实体，必须拥有该实体或具有以下权限：
- 对实体应用标记
- USE SCHEMA 在实体的父架构上
- USE CATALOG 实体的父目录
若要将受治理的标记更新到 Unity 目录实体，还必须对标记策略具有 ASSIGN 或 MANAGE 权限。 请参阅 “管理标记策略权限”。
databricks entity-tag-assignments update ENTITY_TYPE ENTITY_NAME TAG_KEY UPDATE_MASK [flags]
Arguments
ENTITY_TYPE
为其分配标记的实体的类型。 允许的值为：catalogs、、schemas、tablescolumns、 volumes。
ENTITY_NAME
为其分配标记的实体的完全限定名称。
TAG_KEY
标记的键。
UPDATE_MASK
字段掩码必须是单个字符串，多个字段用逗号分隔（无空格）。 字段路径是相对于资源对象而言的，通过点（.）来导航子字段（例如，author.given_name）。 不允许对序列或映射字段中的元素进行规范，因为只能指定整个集合字段。 字段名称必须与资源字段名称完全匹配。
星号 （*） 字段掩码指示完全替换。 建议始终显式列出要更新的字段，避免使用通配符，因为如果 API 将来发生更改，可能会导致意外结果。
选项
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件
--tag-value string
标记的值。
例子
以下示例更新表的标记分配：
databricks entity-tag-assignments update tables my_catalog.my_schema.my_table environment "tag_value" --tag-value staging
以下示例使用 JSON 更新标记分配：
databricks entity-tag-assignments update tables my_catalog.my_schema.my_table environment "tag_value" --json '{"tag_value": "development"}'
全局标志
--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 字符串
如果适用，要使用的捆绑包目标