Remarque
L’accès à cette page requiert une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page requiert une autorisation. Vous pouvez essayer de modifier des répertoires.
Note
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.
Important
Cette fonctionnalité est disponible en préversion publique.
Le secrets-uc groupe de commandes au sein de la CLI Databricks gère les secrets du catalogue Unity. Un secret est un objet sécurisé du catalogue Unity qui stocke des données sensibles d’identifiants (tels que mots de passe, jetons et clés) dans un espace de noms à trois niveaux (catalog_name.schema_name.secret_name). Les secrets peuvent être gérés à l’aide des autorisations standard du catalogue Unity et sont rattachés à un schéma au sein d’un catalogue.
Databricks Secrets-UC create-secret
Crée un nouveau secret dans le catalogue Unity. Vous devez être le propriétaire du schéma parent ou avoir les CREATE_SECRET et USE SCHEMA privilèges sur le schéma parent et USE CATALOG sur le catalogue parent. Le secret est stocké dans le catalogue et le schéma spécifiés, et le champ de valeur contient les données sensibles à stocker de manière sécurisée.
databricks secrets-uc create-secret NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]
Arguments
NAME
Le nom du secret, par rapport à son schéma parent.
CATALOG_NAME
Le nom du catalogue où résident le schéma et le secret.
SCHEMA_NAME
Le nom du schéma où réside le secret.
VALUE
La valeur secrète à stocker. Ce champ est uniquement en entrée et n’est pas retourné en réponse — utilisez le champ effective_value (via GetSecret avec include_value réglé sur true) pour lire la valeur secrète. La taille maximale est de 60 KiB (avant le chiffrement). Le contenu accepté comprend les mots de passe, jetons, clés et autres données sensibles sur les identifiants.
Options
--comment string
Description du secret fournie par l’utilisateur en texte libre.
--expire-time string
Délai d’expiration fourni par l’utilisateur pour le secret.
--json JSON
Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.
--owner string
Le propriétaire du secret.
Databricks Secrets-UC Delete-Secret
Supprime un secret par son nom à trois niveaux (entièrement qualifié). Vous devez être le propriétaire du secret ou un administrateur du Metastore.
databricks secrets-uc delete-secret FULL_NAME [flags]
Arguments
FULL_NAME
Le nom à trois niveaux (entièrement qualifié) du secret (par exemple, catalog_name nom_schéma.nom_secret).
Options
Databricks Secrets-UC get-secret
A un secret grâce à son nom à trois niveaux (entièrement qualifié). Vous devez être administrateur du metastore, propriétaire du secret, ou avoir le privilège GÉRER sur le secret. La valeur secrète n’est pas retournée par défaut. Pour la récupérer, vous devez également avoir le privilège READ_SECRET et définir include_value sur true dans la demande.
databricks secrets-uc get-secret FULL_NAME [flags]
Arguments
FULL_NAME
Le nom à trois niveaux (entièrement qualifié) du secret (par exemple, catalog_name nom_schéma.nom_secret).
Options
Databricks Secrets-UC list-secrets
Liste les secrets dans le catalogue Unity. Vous devez être administrateur du metastore, propriétaire du secret, ou avoir le privilège GÉRER sur le secret. Les catalog_name et schema_name doivent être spécifiés ensemble pour filtrer les secrets au sein d’un schéma spécifique. Les résultats sont paginatus ; Utilisez le champ page_token de la réponse pour récupérer les pages suivantes.
databricks secrets-uc list-secrets [flags]
Options
--catalog-name string
Le nom du catalogue sous lequel lister les secrets.
--limit int
Nombre maximal de résultats à renvoyer.
--page-size int
Nombre maximal de secrets à révéler.
--schema-name string
Le nom du schéma sous lequel lister les secrets.
Databricks Secrets-UC Update-Secret
Met à jour un secret existant dans le catalogue Unity. Vous devez être le propriétaire du secret ou un administrateur du Metastore. Si vous êtes administrateur du Metastore, seul le champ propriétaire peut être modifié. Utilisez le champ update_mask pour spécifier quels champs mettre à jour. Les champs mises à jour supportées incluent valeur, commentaire, propriétaire et expire_time.
databricks secrets-uc update-secret FULL_NAME UPDATE_MASK NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]
Arguments
FULL_NAME
Le nom à trois niveaux (entièrement qualifié) du secret (par exemple, catalog_name nom_schéma.nom_secret).
UPDATE_MASK
Le masque de champ spécifie quels champs du secret mettre à jour. Si update_mask est « * », tous les champs spécifiés en secret sont mis à jour. Si update_mask spécifie un ou plusieurs champs, seuls ces champs sont mis à jour. Chaque champ spécifié doit être défini en secret. Champs supportés : valeur,commentaire, propriétaire, expire_time. Pour changer le nom du secret, supprimez et recréez le secret.
NAME
Le nom du secret, par rapport à son schéma parent.
CATALOG_NAME
Le nom du catalogue où résident le schéma et le secret.
SCHEMA_NAME
Le nom du schéma où réside le secret.
VALUE
La valeur secrète à stocker. Ce champ est uniquement en entrée et n’est pas retourné en réponse — utilisez le champ effective_value (via GetSecret avec include_value réglé sur true) pour lire la valeur secrète. La taille maximale est de 60 KiB (avant le chiffrement). Le contenu accepté comprend les mots de passe, jetons, clés et autres données sensibles sur les identifiants.
Options
--comment string
Description du secret fournie par l’utilisateur en texte libre.
--expire-time string
Délai d’expiration fourni par l’utilisateur pour le secret.
--json JSON
Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.
--owner string
Le propriétaire du secret.
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 dans lequel écrire les logs de sortie. Si cet indicateur n’est pas spécifié, la valeur par défaut consiste à écrire les logs de sortie 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 format du journal. 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