entity-tag-assignments groupe de commande

Note

Ces informations s’appliquent à Databricks CLI versions 0.205 et ultérieures. L’interface CLI Databricks est en préversion publique.

L’utilisation de l’interface CLI Databricks est soumise à la licence Databricks et à la notification de confidentialité Databricks, y compris les dispositions relatives aux données d’utilisation.

Le entity-tag-assignments groupe de commandes au sein de l’interface CLI Databricks contient des commandes pour créer, mettre à jour, supprimer et répertorier des attributions d’étiquettes dans les entités du catalogue Unity. Les balises sont des attributs qui incluent des clés et des valeurs facultatives que vous pouvez utiliser pour organiser et classer des entités dans le catalogue Unity. Consultez l'application des étiquettes aux objets sécurisables dans le Unity Catalog.

databricks entity-tag-assignments create

Créez une attribution d’étiquette pour une entité de catalogue Unity.

Pour ajouter des balises aux entités du catalogue Unity, vous devez posséder l’entité ou disposer des privilèges suivants :

  • APPLY 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 régie aux entités du catalogue Unity, vous devez également disposer de l’autorisation ASSIGN ou MANAGE sur la stratégie de balise. Consultez Gérer les autorisations de politique de balises.

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

Arguments

ENTITY_NAME

    Nom complet de l’entité à laquelle la balise est affectée.

TAG_KEY

    Clé de la balise.

ENTITY_TYPE

    Type de l’entité à laquelle la balise est affectée. Les valeurs autorisées sont les suivantes : catalogs, , schemastables, columns, volumes.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

--tag-value string

    Valeur de la balise.

Indicateurs globaux

Exemples

L’exemple suivant crée une attribution d’étiquette pour une table :

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

L’exemple suivant crée une attribution de balise à l’aide de JSON :

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

databricks entity-tag-assignments delete

Supprimez une attribution d’étiquette pour une entité de catalogue Unity par sa clé.

Pour supprimer des étiquettes des entités du catalogue Unity, vous devez posséder l’entité ou disposer des privilèges suivants :

  • APPLY 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 une balise régie des entités du catalogue Unity, vous devez également disposer de l’autorisation ASSIGN ou MANAGE sur la stratégie d’étiquette. Consultez Gérer les autorisations de politique de balises.

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

Arguments

ENTITY_TYPE

    Type de l’entité à laquelle la balise est affectée. Les valeurs autorisées sont les suivantes : catalogs, , schemastables, columns, volumes.

ENTITY_NAME

    Nom complet de l’entité à laquelle la balise est affectée.

TAG_KEY

    Clé de la balise à supprimer.

Options

Indicateurs globaux

Exemples

L’exemple suivant supprime une attribution d’étiquette d’une table :

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

databricks entity-tag-assignments get

Obtenez une attribution d’étiquette pour une entité de catalogue Unity par clé d’étiquette.

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

Arguments

ENTITY_TYPE

    Type de l’entité à laquelle la balise est affectée. Les valeurs autorisées sont les suivantes : catalogs, , schemastables, columns, volumes.

ENTITY_NAME

    Nom complet de l’entité à laquelle la balise est affectée.

TAG_KEY

    Clé de la balise.

Options

Indicateurs globaux

Exemples

L’exemple suivant obtient une affectation d’étiquette pour une table :

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

databricks entity-tag-assignments list

Répertorier les attributions d’étiquettes pour une entité de catalogue Unity.

Important

L’API est paginé par défaut, une page peut contenir zéro résultat tout en fournissant une next_page_token. Les clients doivent continuer à lire des pages jusqu’à ce que next_page_token soit absent, ce qui indique uniquement que la fin des résultats a été atteinte.

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

Arguments

ENTITY_TYPE

    Type de l’entité à laquelle la balise est affectée. Les valeurs autorisées sont les suivantes : catalogs, , schemastables, columns, volumes.

ENTITY_NAME

    Nom complet de l’entité à laquelle la balise est affectée.

Options

--max-results int

    Nombre maximal de résultats à renvoyer.

--page-token string

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

Indicateurs globaux

Exemples

L’exemple suivant répertorie toutes les attributions d’étiquettes pour une table :

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

L’exemple suivant répertorie les affectations d’étiquettes avec pagination :

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

databricks entity-tag-assignments update

Mettez à jour une attribution de balise existante pour une entité de catalogue Unity.

Pour mettre à jour des étiquettes vers des entités de catalogue Unity, vous devez posséder l’entité ou disposer des privilèges suivants :

  • APPLY 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 une balise régie vers des entités du catalogue Unity, vous devez également disposer de l’autorisation ASSIGN ou MANAGE sur la stratégie de balise. Consultez Gérer les autorisations de politique de balises.

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

Arguments

ENTITY_TYPE

    Type de l’entité à laquelle la balise est affectée. Les valeurs autorisées sont les suivantes : catalogs, , schemastables, columns, volumes.

ENTITY_NAME

    Nom complet de l’entité à laquelle la balise est affectée.

TAG_KEY

    Clé de la balise.

UPDATE_MASK

    Le masque de champ doit être une seule chaîne, avec plusieurs champs séparés par des virgules (aucun espace). Le chemin du champ est relatif à l’objet de ressource, à l’aide d’un point (.) pour parcourir 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 le remplacement complet. Il est recommandé de toujours répertorier explicitement les champs mis à jour et d’éviter d’utiliser des caractères génériques, car cela peut entraîner des résultats inattendus si l’API change à l’avenir.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

--tag-value string

    Valeur de la balise.

Indicateurs globaux

Exemples

L’exemple suivant met à jour une attribution d’étiquette pour une table :

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 :

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

Indicateurs globaux

--debug

  Faut-il activer la journalisation du débogage ?

-h ou --help

    Affiche l’aide pour l’interface CLI de Databricks, le groupe de commandes associé ou la commande concernée.

--log-file chaîne de caractères

    Chaîne représentant le fichier utilisé pour écrire les logs de sortie. Si cet indicateur n’est pas défini, les journaux de sortie sont écrits par défaut dans stderr.

--log-format Format

    Type de format de journal : text ou json. La valeur par défaut est text.

--log-level chaîne de caractères

    Chaîne représentant le niveau de journalisation. Si cet indicateur n’est pas défini, le niveau de format de journal est désactivé.

Type -o, --output

    Type de sortie de commande, text ou json. La valeur par défaut est text.

-p, --profile chaîne de caractères

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

--progress-format Format

    Format permettant d’afficher les journaux de progression : default, append, inplace ou json

-t, --target chaîne de caractères

    Le cas échéant, la cible d'ensemble à utiliser