備註
此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態。
Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明，包括任何使用數據條款。
entity-tag-assignments
Databricks CLI 中的指令群組包含用於建立、更新、刪除及列出 Unity 目錄實體間標籤指派的指令。 標籤是包含鍵和可選值的屬性，可以用來組織和分類 Unity 目錄中的實體。 請參閱 將標籤套用至 Unity Catalog 的可安全物件。
Databricks entity-tag-assignments 建立
為 Unity Catalog 實體建立標籤指派。
要為 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、volumestablescolumns。
選項
--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 實體標籤賦值刪除
依照 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、volumestablescolumns。
ENTITY_NAME
標籤所指派實體的完全限定名稱。
TAG_KEY
刪除標籤的鑰匙。
選項
範例
以下範例是從資料表中刪除標籤指派：
databricks entity-tag-assignments delete tables my_catalog.my_schema.my_table environment
DataBricks entity-tag-assignments 取得
透過標籤鍵取得 Unity Catalog 實體的標籤指派。
databricks entity-tag-assignments get ENTITY_TYPE ENTITY_NAME TAG_KEY [flags]
Arguments
ENTITY_TYPE
標籤所指派的實體類型。 允許的值為：catalogs、schemas、volumestablescolumns。
ENTITY_NAME
標籤所指派實體的完全限定名稱。
TAG_KEY
標籤的鍵值。
選項
範例
以下範例為資料表分配標籤：
databricks entity-tag-assignments get tables my_catalog.my_schema.my_table environment
DataBricks 實體標籤指派列表
Unity 目錄實體的清單標籤指派。
這很重要
API 預設是分頁的，頁面可能沒有結果，但仍然提供next_page_token。 客戶必須持續閱讀頁面直到next_page_token消失，這是唯一表示結果已結束的跡象。
databricks entity-tag-assignments list ENTITY_TYPE ENTITY_NAME [flags]
Arguments
ENTITY_TYPE
標籤所指派的實體類型。 允許的值為：catalogs、schemas、volumestablescolumns。
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 更新
更新 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、volumestablescolumns。
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、、appendinplace、 或json
-t, --target 字串
如果適用，要使用的套件組合目標