Groupe de commandessecrets-uc
L’utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité de Databricks, y compris toute disposition relative aux données sur l’usage.
Aperçu
Cette fonctionnalité est en Aperçu public.
Le groupe de commandes secrets-uc au sein de Databricks CLI gère les secrets Unity Catalog. Un secret est un objet sécurisable Unity Catalog qui stocke des données d'identification sensibles (telles que des mots de passe, des jetons et des clés) au sein d'un espace de noms à trois niveaux (catalog_name.schema_name.secret_name). Les secrets peuvent être gérés à l'aide des autorisations standard Unity Catalog et sont limités à un schéma au sein d'un catalogue.
databricks secrets-uc create-secret
Crée un nouveau secret dans Unity Catalog. Vous devez être le propriétaire du schéma parent ou disposer des privilèges CREATE_SECRET et USE SCHEMA sur le schéma parent, ainsi que du privilège USE CATALOG sur le catalogue parent. Le secret est stocké dans le catalogue et le schéma spécifiés, et le champ value 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, relatif à 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 en entrée uniquement et n’est pas renvoyé dans les réponses — utilisez le champ effective_value (via GetSecret avec include_value défini sur true) pour lire la valeur secrète. La taille maximale est de 60 Kio (avant chiffrement). Le contenu accepté comprend les mots de passe, les jetons, les clés et d’autres données d’identification sensibles.
Options
--comment string
Description textuelle libre du secret fournie par l'utilisateur.
--expire-time string
Délai d’expiration du secret fourni par l’utilisateur.
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON contenant 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 métastore.
databricks secrets-uc delete-secret FULL_NAME [flags]
Arguments
FULL_NAME
Le nom à trois niveaux (entièrement qualifié) du secret (par exemple, catalog_name.schema_name.secret_name ).
Options
databricks secrets-uc get-secret
Récupère un secret par son nom à trois niveaux (entièrement qualifié). Vous devez être administrateur du métastore, propriétaire du secret ou disposer du privilège MANAGE sur le secret. La valeur du secret n'est pas renvoyée par default. Pour le récupérer, vous devez également disposer du privilège READ_SECRET et définir include_value sur true dans la requête.
databricks secrets-uc get-secret FULL_NAME [flags]
Arguments
FULL_NAME
Le nom à trois niveaux (entièrement qualifié) du secret (par exemple, catalog_name.schema_name.secret_name ).
Options
databricks secrets-uc list-secrets
Liste les secrets dans Unity Catalog. Vous devez être administrateur du métastore, propriétaire du secret ou disposer du privilège MANAGE sur le secret. 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 paginés ; 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
Nom du catalogue sous lequel lister les secrets.
--limit int
Nombre maximal de résultats à renvoyer.
--page-size int
Nombre maximal de secrets à renvoyer.
--schema-name string
Le nom du schéma sous lequel lister les secrets.
databricks secrets-uc update-secret
Met à jour un secret existant dans Unity Catalog. Vous devez être le propriétaire du secret ou un administrateur du métastore. Si vous êtes administrateur du métastore, seul le champ owner peut être modifié. Utilisez le champ update_mask pour spécifier les champs à mettre à jour. Les champs modifiables pris en charge incluent value , comment , owner 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.schema_name.secret_name ).
UPDATE_MASK
Le masque de champ spécifiant les champs du secret à mettre à jour. Si update_mask est « * » , tous les champs spécifiés dans 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 dans secret . Champs pris en charge : value , comment , owner , expire_time . Pour modifier le nom du secret, supprimez et recréez le secret.
NAME
Le nom du secret, relatif à 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 en entrée uniquement et n’est pas renvoyé dans les réponses — utilisez le champ effective_value (via GetSecret avec include_value défini sur true) pour lire la valeur secrète. La taille maximale est de 60 Kio (avant chiffrement). Le contenu accepté comprend les mots de passe, les jetons, les clés et d’autres données d’identification sensibles.
Options
--comment string
Description textuelle libre du secret fournie par l'utilisateur.
--expire-time string
Délai d’expiration du secret fourni par l’utilisateur.
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON contenant le corps de la requête.
--owner string
Le propriétaire du secret.
Indicateurs globaux
--debug
Indique s'il faut activer la journalisation de débogage.
-h OU --help
Affiche l’aide pour la CLI Databricks, le groupe de commandes associé ou 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é, le comportement default consiste à écrire les Logs de sortie dans stderr.
--log-format Format
Le type de format de Logs, text ou json. La valeur par default est text.
--log-level chaîne
Une chaîne représentant le niveau de format de log. Si rien n'est spécifié, le niveau de format de log est désactivé.
-o, --output Type
Type de sortie de la commande, text ou json. La valeur par default est text.
-p, --profile chaîne
Le nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, le profil nommé DEFAULT est utilisé s'il existe.
--progress-format Format
Le format d'affichage des logs de progression : default, append, inplace ou json
-t, --target chaîne
Le cas échéant, la cible de bundle à utiliser