Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
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 secrets groupe de commandes dans l’interface CLI Databricks vous permet de gérer les secrets, les étendues secrètes et les autorisations d’accès. Parfois, l’accès aux données nécessite que vous vous authentifiez auprès de sources de données externes via JDBC. Au lieu d’entrer directement vos informations d’identification dans un notebook, utilisez les secrets Databricks pour stocker vos informations d’identification et les référencer dans les blocs-notes et les travaux. Consultez la gestion des secrets.
databricks secrets create-scope
Crée une nouvelle étendue de secrets.
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 d’étendues sont uniques.
Options
--initial-manage-principal string
Principal qui reçoit initialement l’autorisation MANAGE pour l’étendue créée.
--json JSON
Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.
--scope-backend-type ScopeBackendType
Type de back-end avec lequel l’étendue sera créée. Valeurs prises en charge : AZURE_KEYVAULT, DATABRICKS
databricks secrets delete-acl
Supprimez l'ACL donnée sur le périmètre spécifié.
Les utilisateurs doivent avoir l’autorisation MANAGE d’appeler cette commande. Lève une exception RESOURCE_DOES_NOT_EXIST si une telle étendue de secrets, un tel principal ou une telle liste de contrôle d’accès n’existe pas. Lève une exception PERMISSION_DENIED si l’utilisateur n’a pas l’autorisation nécessaire pour effectuer cet appel d’API.
databricks secrets delete-acl SCOPE PRINCIPAL [flags]
Arguments
SCOPE
Nom de l’étendue à partir duquel supprimer les autorisations.
PRINCIPAL
Principal dont il faut supprimer une liste de contrôle d’accès existante.
Options
--json JSON
Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.
databricks secrets delete-scope
Supprimez une étendue de secrets.
Lève une exception RESOURCE_DOES_NOT_EXIST si l’étendue n’existe pas. Lève une exception PERMISSION_DENIED si l’utilisateur n’a pas l’autorisation nécessaire pour effectuer cet appel.
databricks secrets delete-scope SCOPE [flags]
Arguments
SCOPE
Nom de l’étendue à supprimer.
Options
--json JSON
Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.
databricks secrets delete-secret
Supprimez le secret stocké dans cette étendue de secrets. Vous devez avoir l’autorisation WRITE ou MANAGE sur l’étendue de secrets.
Lève une exception RESOURCE_DOES_NOT_EXIST si une telle étendue de secrets ou un tel secret n’existe pas. Lève une exception PERMISSION_DENIED si l’utilisateur n’a pas l’autorisation nécessaire pour effectuer cet appel.
databricks secrets delete-secret SCOPE KEY [flags]
Arguments
SCOPE
Nom de l’étendue qui contient le secret à supprimer.
KEY
Nom du secret à supprimer.
Options
--json JSON
Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.
databricks secrets get-acl (obtenir la liste de contrôle d'accès)
Obtenez les détails concernant l'ACL donnée, tels que le groupe et l'autorisation. Les utilisateurs doivent avoir l’autorisation MANAGE d’appeler cette API.
Lève une exception RESOURCE_DOES_NOT_EXIST si une telle étendue de secrets n’existe pas. Lève une exception PERMISSION_DENIED si l’utilisateur n’a pas l’autorisation nécessaire pour effectuer cet appel.
databricks secrets get-acl SCOPE PRINCIPAL [flags]
Arguments
SCOPE
Nom de l’étendue à partir de laquelle récupérer les informations de la liste de contrôle d’accès.
PRINCIPAL
Principal pour lequel récupérer les informations de la liste de contrôle d’accès.
Options
databricks secrets get-secret
Obtient la représentation sous forme de chaîne d’une valeur secrète pour la portée et la clé spécifiés.
Les utilisateurs ont besoin de l’autorisation d’effectuer READ cet appel.
Notez que la valeur secrète retourné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.
Lève une exception PERMISSION_DENIED si l’utilisateur n’a pas l’autorisation nécessaire pour effectuer cet appel d’API. Lève une exception RESOURCE_DOES_NOT_EXIST si un tel secret ou une telle étendue de secrets n’existe pas.
databricks secrets get-secret SCOPE KEY [flags]
Arguments
SCOPE
Nom de l’étendue à partir de laquelle récupérer les informations secrètes.
KEY
Clé permettant de récupérer le secret.
Options
databricks secrets list-acls (lister les ACL des secrets dans Databricks)
Répertoriez les listes de contrôle d’accès pour une étendue secrète donnée. Les utilisateurs doivent avoir l’autorisation MANAGE d’appeler cette API.
Lève une exception RESOURCE_DOES_NOT_EXIST si une telle étendue de secrets n’existe pas. Lève une exception PERMISSION_DENIED si l’utilisateur n’a pas l’autorisation nécessaire pour effectuer cet appel.
databricks secrets list-acls SCOPE [flags]
Arguments
SCOPE
Nom de l’étendue à partir de laquelle récupérer les informations de la liste de contrôle d’accès.
Options
étendues de liste des secrets databricks
Lister tous les espaces secrets disponibles dans l’espace de travail.
Lève une exception PERMISSION_DENIED si l’utilisateur n’a pas l’autorisation nécessaire pour effectuer cet appel.
databricks secrets list-scopes [flags]
Options
databricks secrets list-secrets
Répertoriez les clés secrètes qui sont stockées dans cette étendue. 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 l’autorisation d’effectuer READ cet appel.
Le lastUpdatedTimestamp retourné est exprimé en millisecondes depuis l'époque Unix. Lève une exception RESOURCE_DOES_NOT_EXIST si une telle étendue de secrets n’existe pas. Lève une exception PERMISSION_DENIED si l’utilisateur n’a pas l’autorisation nécessaire pour effectuer cet appel.
databricks secrets list-secrets SCOPE [flags]
Arguments
SCOPE
Nom de l’étendue à lister pour les secrets.
Options
databricks secrets put-acl
Créez ou remplacez la liste de contrôle d’accès associée au principal (utilisateur ou groupe) donné sur le point d’étendue spécifié.
En général, un utilisateur ou un groupe utilisera l’autorisation la plus puissante à leur disposition et les autorisations sont classées comme suit :
-
MANAGEAutorisé à modifier les listes de contrôle d’accès, à lire et à écrire dans ce périmètre secret. -
WRITEAutorisation de lecture et d'écriture dans cet espace secret. -
READ: Autorisé à lire cette étendue de secrets et à répertorier les secrets disponibles.
Notez que, en général, les valeurs secrètes ne peuvent être lues qu’à partir d’une commande sur un cluster (par exemple, via un bloc-notes). Il n’existe aucune API pour lire le matériel de valeur secrète réelle en dehors d’un cluster. Toutefois, l’autorisation de l’utilisateur est appliquée en fonction des personnes qui exécutent la commande, et elle doit avoir au moins l’autorisation READ.
Les utilisateurs doivent avoir l’autorisation MANAGE d’appeler cette commande.
Le principal est un nom d’utilisateur ou de groupe correspondant à un principal Databricks existant à qui on peut accorder ou révoquer l’accès.
Lève une exception RESOURCE_DOES_NOT_EXIST si une telle étendue de secrets n’existe pas. Lève une exception RESOURCE_ALREADY_EXISTS si une autorisation pour le principal existe déjà. Lève INVALID_PARAMETER_VALUE si l’autorisation ou le principal n’est pas valide. Lève une exception PERMISSION_DENIED si l’utilisateur n’a pas l’autorisation nécessaire pour effectuer cet appel.
databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]
Arguments
SCOPE
Nom de l’étendue à laquelle appliquer des autorisations.
PRINCIPAL
Principal dans lequel l’autorisation est appliquée.
PERMISSION
Niveau d’autorisation appliqué à l'utilisateur principal. Valeurs prises en charge : MANAGE, READ, WRITE
Options
--json JSON
Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.
databricks secrets put-secret
Insérez un secret sous l’étendue fournie avec le nom donné. Si un secret existe déjà avec le même nom, cette commande remplace la valeur du secret existant. Le serveur chiffre le secret à l’aide des paramètres de chiffrement de l’étendue de secrets avant de le stocker.
Vous devez avoir l’autorisation WRITE ou MANAGE sur l’étendue de secrets. La clé secrète doit comporter des caractères alphanumériques, des tirets, des traits de soulignement et des points, et ne peut pas dépasser 128 caractères. La taille maximale de la valeur secrète autorisée est de 128 Ko. Le nombre maximal de secrets dans une étendue donnée est de 1 000.
Arguments string-value ou bytes-value spécifiez le type du secret, qui détermine la valeur retournée lorsque la valeur secrète est demandée.
Vous pouvez spécifier la valeur secrète de l’une des trois manières suivantes :
- Spécifiez la valeur sous forme de chaîne à l’aide de l’indicateur
--string-value. - Entrez le secret lorsque vous y êtes invité de manière interactive (secrets à ligne unique).
- Passez le secret via une entrée standard (secrets multilignes).
databricks secrets put-secret SCOPE KEY [flags]
Arguments
SCOPE
Le nom de l'étendue dans laquelle stocker le secret.
KEY
Nom de clé du secret.
Options
--bytes-value string
Si elle est spécifiée, la valeur est stockée sous forme d’octets.
--json JSON
Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.
--string-value string
Si elle est spécifiée, notez que la valeur sera stockée dans le formulaire UTF-8 (Mo4).
Indicateurs globaux
--debug
Active 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
Chaîne représentant le fichier dans lequel écrire les journaux de sortie. Si cet indicateur n’est pas défini, les journaux de sortie sont écrits par défaut dans stderr.
--log-format format
Format des journaux : text ou json. La valeur par défaut est text.
--log-level chaîne
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
Format de sortie de la commande : text ou json. La valeur par défaut 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 défini, le profil nommé DEFAULT est utilisé, s’il existe.
--progress-format format
Format d’affichage des journaux d’activité de progression : default, append, inplace ou json
-t, --target chaîne
Le cas échéant, cible du bundle à utiliser