entity-tag-assignmentsコマンドグループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI はパブリック プレビュー段階です。
Databricks CLI使用には、使用状況データ プロビジョニングを含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。
Databricks CLI内のentity-tag-assignmentsコマンド グループにはUnity Catalogエンティティ全体のタグ割り当てを作成、更新、削除、一覧表示するためのコマンドが含まれています。 タグは、 Unity Catalog内のエンティティを整理および分類するために使用できるキーとオプションの値を含む属性です。 「Unity Catalog のセキュリティ保護可能なオブジェクトにタグを適用する」を参照してください。
データブリックスエンティティタグ割り当て作成
Unity Catalogエンティティのタグ割り当てを作成します。
Unity Catalog エンティティにタグを追加するには、エンティティを所有しているか、次の権限を持っている必要があります。
- エンティティに タグを適用する
- エンティティの親スキーマに対する USE SCHEMA
- エンティティの親カタログに対する USE CATALOG
Unity Catalogエンティティに管理タグを追加するには、タグ ポリシーに対する ASSIGN または MANAGE 権限も必要です。 「タグ ポリシー権限の管理」を参照してください。
databricks entity-tag-assignments create ENTITY_NAME TAG_KEY ENTITY_TYPE [flags]
議論
ENTITY_NAME
タグが割り当てられているエンティティの完全修飾名。
TAG_KEY
タグのキー。
ENTITY_TYPE
タグが割り当てられるエンティティのタイプ。許可される値はcatalogs 、 schemas 、 tables 、 columns 、 volumesです。
オプション
--json JSON
インラインJSON文字列またはリクエストボディを含むJSONファイルへの@path
--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"}'
データブリックスエンティティタグ割り当ての削除
キーによってUnity Catalogエンティティのタグ割り当てを削除します。
Unity Catalogエンティティから タグ を削除するには、そのエンティティを所有しているか、次の権限を持っている必要があります。
- エンティティに タグを適用する
- エンティティの親スキーマの USE_SCHEMA
- エンティティの親カタログの USE_CATALOG
Unity Catalogエンティティから管理タグを削除するには、タグ ポリシーに対する ASSIGN または MANAGE 権限も必要です。 「タグ ポリシー権限の管理」を参照してください。
databricks entity-tag-assignments delete ENTITY_TYPE ENTITY_NAME TAG_KEY [flags]
議論
ENTITY_TYPE
タグが割り当てられるエンティティのタイプ。許可される値はcatalogs 、 schemas 、 tables 、 columns 、 volumesです。
ENTITY_NAME
タグが割り当てられているエンティティの完全修飾名。
TAG_KEY
削除するタグのキー。
オプション
例
次の例では、テーブルからタグの割り当てを削除します。
databricks entity-tag-assignments delete tables my_catalog.my_schema.my_table environment
データブリックスエンティティタグ割り当て取得
タグキーによりUnity Catalogエンティティのタグ割り当てを取得します。
databricks entity-tag-assignments get ENTITY_TYPE ENTITY_NAME TAG_KEY [flags]
議論
ENTITY_TYPE
タグが割り当てられるエンティティのタイプ。許可される値はcatalogs 、 schemas 、 tables 、 columns 、 volumesです。
ENTITY_NAME
タグが割り当てられているエンティティの完全修飾名。
TAG_KEY
タグのキー。
オプション
例
次の例では、テーブルのタグ割り当てを取得します。
databricks entity-tag-assignments get tables my_catalog.my_schema.my_table environment
Databricks エンティティタグ割り当てリスト
Unity Catalogエンティティのタグの割り当てを一覧表示します。
API はデフォルトでページ分割されており、next_page_token を提供しながらもページに結果が 0 個含まれる場合があります。クライアントは、結果の終わりに達したことを示す唯一の指標である next_page_token がなくなるまで、ページの読み取りを続ける必要があります。
databricks entity-tag-assignments list ENTITY_TYPE ENTITY_NAME [flags]
議論
ENTITY_TYPE
タグが割り当てられるエンティティのタイプ。許可される値はcatalogs 、 schemas 、 tables 、 columns 、 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 エンティティタグ割り当ての更新
Unity Catalogエンティティの既存のタグ割り当てを更新します。
Unity Catalog エンティティのタグを更新するには、エンティティを所有しているか、次の権限を持っている必要があります。
- エンティティに タグを適用する
- エンティティの親スキーマに対する USE SCHEMA
- エンティティの親カタログに対する USE CATALOG
管理タグをUnity Catalogエンティティに更新するには、タグ ポリシーに対する ASSIGN または MANAGE 権限も必要です。 「タグ ポリシー権限の管理」を参照してください。
databricks entity-tag-assignments update ENTITY_TYPE ENTITY_NAME TAG_KEY UPDATE_MASK [flags]
議論
ENTITY_TYPE
タグが割り当てられるエンティティのタイプ。許可される値はcatalogs 、 schemas 、 tables 、 columns 、 volumesです。
ENTITY_NAME
タグが割り当てられているエンティティの完全修飾名。
TAG_KEY
タグのキー。
UPDATE_MASK
フィールド マスクは単一の文字列で、複数のフィールドはコンマ (スペースなし) で区切る必要があります。フィールド パスはリソース オブジェクトを基準とし、ドット ( . ) を使用してサブフィールド (例: author.given_name ) を移動します。コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。フィールド名はリソース フィールド名と完全に一致する必要があります。
アスタリスク ( * ) フィールド マスクは完全置換を示します。将来 API が変更された場合に意図しない結果が生じる可能性があるため、更新されるフィールドを常に明示的にリストし、ワイルドカードの使用を避けることをお勧めします。
オプション
--json JSON
インラインJSON文字列またはリクエストボディを含むJSONファイルへの@path
--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 string
出力ログを書き込むファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログは stderr に書き込まれます。
--log-format format
ログ形式のタイプ、 textまたはjson 。デフォルト値はtextです。
--log-level string
ログ形式のレベルを表す文字列。指定しない場合は、ログ形式のレベルは無効になります。
-o, --output タイプ
コマンド出力タイプ、 textまたはjson 。デフォルト値はtextです。
-p, --profile string
コマンドを実行するために使用する~/.databrickscfgファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULTという名前のプロファイルが使用されます。
--progress-format format
進捗ログを表示する形式: default 、 append 、 inplace 、または json
-t, --target string
該当する場合、使用するバンドルターゲット