groupe de commandessecrets
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 secrets dans la Databricks CLI vous permet de gérer les secrets, les Secret Scope et les autorisations d'accès. Parfois, l'accès aux données nécessite que vous vous authentifiiez à des sources de données externes via JDBC. Au lieu de saisir directement vos identifiants dans un notebook, utilisez les secrets Databricks pour stocker vos identifiants et les référencer dans les notebooks et les jobs. Consultez Gestion des secrets.
databricks secrets create-scope
Créez un nouveau Secret Scope.
Le nom de l'étendue doit être composé de caractères alphanumériques, de tirets, de traits de soulignement et de points, et ne doit pas dépasser 128 caractères.
databricks secrets create-scope SCOPE [flags]
Arguments
SCOPE
Nom de l'étendue demandé par l'utilisateur. Les noms de portée sont uniques.
Options
--initial-manage-principal string
Le principal auquel l'autorisation MANAGE est initialement accordée pour le périmètre créé.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--scope-backend-type ScopeBackendType
Le type de backend avec lequel le périmètre sera créé. Valeurs supportées : AZURE_KEYVAULT, DATABRICKS
databricks secrets delete-acl
Supprimez l'ACL donnée sur l'étendue donnée.
Les utilisateurs doivent disposer de l'autorisation MANAGE pour invoquer cette commande. Génère RESOURCE_DOES_NOT_EXIST si aucun Secret Scope, principal ou ACL de ce type n'existe. Lève l'exception PERMISSION_DENIED si l'utilisateur n'a pas la permission d'effectuer cet appel d'API.
databricks secrets delete-acl SCOPE PRINCIPAL [flags]
Arguments
SCOPE
Le nom de la portée à partir de laquelle supprimer les autorisations.
PRINCIPAL
Le principal dont il faut supprimer une ACL existante.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks secrets delete-scope
Supprimer un Secret Scope.
Lance RESOURCE_DOES_NOT_EXIST si l'étendue n'existe pas. Déclenche PERMISSION_DENIED si l'utilisateur n'a pas l'autorisation d'effectuer cet appel.
databricks secrets delete-scope SCOPE [flags]
Arguments
SCOPE
Nom du scope à supprimer.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks secrets delete-secret
Supprimez le secret stocké dans ce Secret Scope. Vous devez disposer des autorisations WRITE ou MANAGE sur le Secret Scope.
Lance RESOURCE_DOES_NOT_EXIST si aucun Secret Scope ou secret de ce type n'existe. Déclenche PERMISSION_DENIED si l'utilisateur n'a pas l'autorisation d'effectuer cet appel.
databricks secrets delete-secret SCOPE KEY [flags]
Arguments
SCOPE
Le nom du périmètre qui contient le secret à supprimer.
KEY
Nom du secret à supprimer.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks secrets get-acl
Obtenez les détails sur l'ACL donnée, tels que le groupe et l'autorisation. Les utilisateurs doivent avoir l'autorisation MANAGE pour invoquer cette API.
Lance RESOURCE_DOES_NOT_EXIST si aucun Secret Scope de ce type n'existe. Déclenche PERMISSION_DENIED si l'utilisateur n'a pas l'autorisation d'effectuer cet appel.
databricks secrets get-acl SCOPE PRINCIPAL [flags]
Arguments
SCOPE
Le nom du scope dont il faut récupérer les informations d'ACL.
PRINCIPAL
Le principal pour lequel récupérer les informations ACL.
Options
Databricks secrets get-secret
Obtenez la représentation en octets d'une valeur secrète pour le périmètre et la clé spécifiés.
Les utilisateurs ont besoin de l'autorisation READ pour effectuer cet appel.
Notez que la valeur secrète renvoyée est en octets. L'interprétation des octets est déterminée par l'appelant dans DBUtils et le type dans lequel les données sont décodées.
Renvoie PERMISSION_DENIED si l'utilisateur n'a pas la permission d'effectuer cet appel d'API. Renvoie RESOURCE_DOES_NOT_EXIST si aucun secret ou Secret Scope de ce type n'existe.
databricks secrets get-secret SCOPE KEY [flags]
Arguments
SCOPE
Le nom de l'étendue pour récupérer les informations secrètes.
KEY
La clé pour récupérer le secret.
Options
databricks secrets list-acls
Affichez les ACL d'un Secret Scope donné. Les utilisateurs doivent avoir l'autorisation MANAGE pour invoquer cette API.
Lance RESOURCE_DOES_NOT_EXIST si aucun Secret Scope de ce type n'existe. Déclenche PERMISSION_DENIED si l'utilisateur n'a pas l'autorisation d'effectuer cet appel.
databricks secrets list-acls SCOPE [flags]
Arguments
SCOPE
Le nom du scope dont il faut récupérer les informations d'ACL.
Options
databricks secrets list-scopes
Listez tous les Secret Scope disponibles dans le Workspace.
Lève PERMISSION_DENIED si l'utilisateur n'a pas la permission d'effectuer cet appel.
databricks secrets list-scopes [flags]
Options
databricks secrets list-secrets
Énumérez les clés secrètes qui sont stockées dans ce périmètre. Il s’agit d’une opération de métadonnées uniquement ; les données secrètes ne peuvent pas être récupérées à l’aide de cette commande. Les utilisateurs ont besoin de la permission READ pour effectuer cet appel.
Le lastUpdatedTimestamp retourné est en millisecondes depuis l'Epoch. Lance RESOURCE_DOES_NOT_EXIST si aucun Secret Scope de ce type n'existe. Lance PERMISSION_DENIED si l'utilisateur n'a pas l'autorisation d'effectuer cet appel.
databricks secrets list-secrets SCOPE [flags]
Arguments
SCOPE
Le nom du périmètre pour lister les secrets.
Options
databricks secrets put-acl
Créez ou écrasez la liste de contrôle d'accès (ACL) associée au principal donné (utilisateur ou groupe) sur le point d'étendue spécifié.
En général, un utilisateur ou un groupe utilisera l'autorisation la plus puissante dont il dispose, et les autorisations sont classées comme suit :
MANAGEAutorisé à modifier les ACL, et à lire et à écrire dans ce Secret Scope.WRITEAutorisé à lire et à écrire dans ce Secret Scope.READAutorisé à lire ce Secret Scope et à lister les secrets disponibles.
Notez qu'en général, les valeurs secrètes ne peuvent être lues qu'à partir d'une commande sur un cluster (par exemple, via un notebook). Il n'existe pas d'API pour lire le contenu réel de la valeur secrète en dehors d'un cluster. Cependant, l'autorisation de l'utilisateur sera appliquée en fonction de la personne qui exécute la commande, et elle doit disposer au moins de l'autorisation READ.
Les utilisateurs doivent avoir l'autorisation MANAGE pour invoquer cette commande.
Le principal est un nom d'utilisateur ou de groupe correspondant à un principal Databricks existant auquel l'accès doit être accordé ou révoqué.
Lance RESOURCE_DOES_NOT_EXIST si aucun Secret Scope de ce type n'existe. Lance RESOURCE_ALREADY_EXISTS si une autorisation pour le principal existe déjà. Renvoie INVALID_PARAMETER_VALUE si l'autorisation ou le principal est invalide. Renvoie PERMISSION_DENIED si l'utilisateur n'a pas l'autorisation d'effectuer cet appel.
databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]
Arguments
SCOPE
Le nom de la portée à laquelle appliquer les autorisations.
PRINCIPAL
L’entité principale à laquelle la permission est appliquée.
PERMISSION
Le niveau d'autorisation appliqué au principal. Valeurs prises en charge : MANAGE, READ, WRITE
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks secrets put-secret
Insérez un secret sous le périmètre fourni avec le nom indiqué. Si un secret existe déjà avec le même nom, cette commande écrase la valeur du secret existant. Le serveur chiffre le secret en utilisant les paramètres de chiffrement du Secret Scope avant de le stocker.
Vous devez disposer de l’autorisation WRITE ou MANAGE sur le Secret Scope. La clé secrète doit être composée de caractères alphanumériques, de tirets, de traits de soulignement et de points, et ne peut pas dépasser 128 caractères. La taille maximale autorisée de la valeur secrète est de 128 KB. Le nombre maximal de secrets dans un périmètre donné est de 1000.
Les arguments string-value ou bytes-value spécifient le type du secret, qui déterminera la valeur renvoyée lorsque la valeur du secret est demandée.
Vous pouvez spécifier la valeur secrète de trois manières :
- Spécifiez la valeur sous forme de chaîne à l'aide de l'indicateur
--string-value. - Saisissez le secret lorsque vous y êtes invité de manière interactive (secrets sur une seule ligne).
- Transmettez le secret via l’entrée standard (secrets multilignes).
databricks secrets put-secret SCOPE KEY [flags]
Arguments
SCOPE
Le nom du périmètre dans lequel stocker le secret.
KEY
Le nom de la clé du secret.
Options
--bytes-value string
Si spécifié, la valeur sera stockée en octets.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--string-value string
Si spécifiée, notez que la valeur sera stockée au format UTF-8 (MB4).
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