Aller au contenu principal

groupe de commandesentity-tag-assignments

remarque

L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.

Le groupe de commandes entity-tag-assignments au sein de la Databricks CLI contient des commandes permettant de créer, mettre à jour, supprimer et lister les attributions de tags à travers les entités Unity Catalog. Les tags sont des attributs qui incluent des clés et des valeurs facultatives que vous pouvez utiliser pour organiser et catégoriser des entités dans Unity Catalog. Voir Appliquer des tags aux objets sécurisables de Unity Catalog.

databricks entity-tag-assignments create

Créez une affectation de tag pour une entité Unity Catalog.

Pour ajouter des tags aux entités Unity Catalog, vous devez être propriétaire de l'entité ou disposer des privilèges suivants :

  • APPLIQUER UN TAG sur l'entité
  • USE SCHEMA sur le schéma parent de l'entité
  • USE CATALOG sur le catalogue parent de l'entité

Pour ajouter une balise gouvernée aux entités Unity Catalog, vous devez également disposer de l’autorisation **ASSIGN** ou **MANAGE** sur la politique de balises. Voir Gérer les autorisations de la politique de tag.

databricks entity-tag-assignments create ENTITY_NAME TAG_KEY ENTITY_TYPE [flags]

Arguments

ENTITY_NAME

Le nom entièrement qualifié de l'entité à laquelle l'étiquette est attribuée.

TAG_KEY

La clé du tag.

ENTITY_TYPE

Le type d'entité à laquelle le tag est assigné. Les valeurs autorisées sont : catalogs, schemas, tables, columns, volumes.

Options

--json JSON

La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête

--tag-value string

La valeur du tag.

Indicateurs globaux

Exemples

L'exemple suivant crée une affectation de tag pour une table :

Bash
databricks entity-tag-assignments create my_catalog.my_schema.my_table environment tables --tag-value production

L'exemple suivant crée une affectation de tag à l'aide de JSON :

Bash
databricks entity-tag-assignments create my_catalog.my_schema.my_table department tables --json '{"tag_value": "finance"}'

databricks entity-tag-assignments delete

Supprimer une attribution de balise pour une entité Unity Catalog par sa clé.

Pour supprimer des tags d'entités Unity Catalog, vous devez être propriétaire de l'entité ou disposer des privilèges suivants :

  • APPLIQUER UN TAG sur l'entité
  • USE_SCHEMA sur le schéma parent de l'entité
  • USE_CATALOG sur le catalogue parent de l'entité

Pour supprimer un tag gouverné des entités Unity Catalog, vous devez également disposer de l'autorisation ASSIGN ou MANAGE sur la politique de tags. Voir Gérer les autorisations de la politique de tag.

databricks entity-tag-assignments delete ENTITY_TYPE ENTITY_NAME TAG_KEY [flags]

Arguments

ENTITY_TYPE

Le type d'entité à laquelle le tag est assigné. Les valeurs autorisées sont : catalogs, schemas, tables, columns, volumes.

ENTITY_NAME

Le nom entièrement qualifié de l'entité à laquelle l'étiquette est attribuée.

TAG_KEY

La clé de la balise à supprimer.

Options

Indicateurs globaux

Exemples

L'exemple suivant supprime une attribution de balise d'une table :

Bash
databricks entity-tag-assignments delete tables my_catalog.my_schema.my_table environment

Databricks entity-tag-assignments get

Obtenir une affectation de tag pour une entité Unity Catalog par clé de tag.

databricks entity-tag-assignments get ENTITY_TYPE ENTITY_NAME TAG_KEY [flags]

Arguments

ENTITY_TYPE

Le type d'entité à laquelle le tag est assigné. Les valeurs autorisées sont : catalogs, schemas, tables, columns, volumes.

ENTITY_NAME

Le nom entièrement qualifié de l'entité à laquelle l'étiquette est attribuée.

TAG_KEY

La clé du tag.

Options

Indicateurs globaux

Exemples

L'exemple suivant récupère une attribution de tag pour une table :

Bash
databricks entity-tag-assignments get tables my_catalog.my_schema.my_table environment

Liste des attributions de tags d'entités Databricks

Lister les attributions de tags pour une entité Unity Catalog.

important

L'API est paginée par default ; une page peut contenir zéro résultat tout en fournissant un next_page_token. Les clients doivent continuer à lire les pages jusqu'à ce que next_page_token soit absent, ce qui est la seule indication que la fin des résultats a été atteinte.

databricks entity-tag-assignments list ENTITY_TYPE ENTITY_NAME [flags]

Arguments

ENTITY_TYPE

Le type d'entité à laquelle le tag est assigné. Les valeurs autorisées sont : catalogs, schemas, tables, columns, volumes.

ENTITY_NAME

Le nom entièrement qualifié de l'entité à laquelle l'étiquette est attribuée.

Options

--max-results int

Nombre maximal de résultats à renvoyer.

--page-token string

Jeton pour récupérer la page suivante de résultats.

Indicateurs globaux

Exemples

L'exemple suivant répertorie toutes les attributions de tags pour une table :

Bash
databricks entity-tag-assignments list tables my_catalog.my_schema.my_table

L'exemple suivant liste les attributions de balises avec pagination :

Bash
databricks entity-tag-assignments list tables my_catalog.my_schema.my_table --max-results 10

databricks mise à jour des attributions de tags d'entité

Mettre à jour une affectation de tag existante pour une entité Unity Catalog.

Pour mettre à jour les balises des entités Unity Catalog, vous devez être propriétaire de l'entité ou posséder les privilèges suivants :

  • APPLIQUER UN TAG sur l'entité
  • USE SCHEMA sur le schéma parent de l'entité
  • USE CATALOG sur le catalogue parent de l'entité

Pour mettre à jour un tag régi vers des entités Unity Catalog, vous devez également disposer de l'autorisation **ATTRIBUER** ou **GÉRER** sur la politique de tag. Voir Gérer les autorisations de la politique de tag.

databricks entity-tag-assignments update ENTITY_TYPE ENTITY_NAME TAG_KEY UPDATE_MASK [flags]

Arguments

ENTITY_TYPE

Le type d'entité à laquelle le tag est assigné. Les valeurs autorisées sont : catalogs, schemas, tables, columns, volumes.

ENTITY_NAME

Le nom entièrement qualifié de l'entité à laquelle l'étiquette est attribuée.

TAG_KEY

La clé du tag.

UPDATE_MASK

Le masque de champ doit être une chaîne unique, avec plusieurs champs séparés par des virgules (sans espaces). Le chemin de champ est relatif à l’objet ressource, en utilisant un point (.) pour naviguer dans les sous-champs (par exemple, author.given_name). La spécification d’éléments dans des champs de séquence ou de carte n’est pas autorisée, car seul le champ de collection entier peut être spécifié. Les noms de champs doivent correspondre exactement aux noms des champs de ressource.

Un masque de champ astérisque (*) indique un remplacement complet. Il est recommandé de toujours lister explicitement les champs mis à jour et d'éviter l'utilisation de caractères génériques, car cela peut entraîner des résultats inattendus si l'API change à l'avenir.

Options

--json JSON

La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête

--tag-value string

La valeur du tag.

Indicateurs globaux

Exemples

L'exemple suivant met à jour l'attribution d'un tag pour une table :

Bash
databricks entity-tag-assignments update tables my_catalog.my_schema.my_table environment "tag_value" --tag-value staging

L'exemple suivant met à jour une attribution de balise à l'aide de JSON :

Bash
databricks entity-tag-assignments update tables my_catalog.my_schema.my_table environment "tag_value" --json '{"tag_value": "development"}'

Drapeaux globaux

--debug

Activer ou non la journalisation de débogage.

-h OU --help

Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.

--log-file chaîne

Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.

--log-format Format

Le type de format de log, text ou json. La valeur par default est text.

--log-level chaîne

Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.

-o, --output Type

Le type de sortie de commande, text ou json. La valeur par default est text.

-p, --profile chaîne

Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.

--progress-format Format

Le format pour afficher les logs de progression : default, append, inplace ou json

-t, --target chaîne

Le cas échéant, la cible de bundle à utiliser