groupe de commandessandbox
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 sandbox au sein de la Databricks CLI vous aide à créer, configurer et accéder aux environnements Databricks Sandbox.
Bêta
Databricks Sandbox est en version bêta.
Les environnements Databricks Sandbox sont des environnements de développement accessibles par SSH, reposant sur l'isolation micro-VM. Chaque sandbox est un environnement personnel avec des outils préinstallés (Python, Node.js, Rust et la CLI Databricks) ainsi que du stockage persistant.
Pour plus d'informations sur Databricks Sandbox, consultez Databricks Sandbox.
Pour commencer :
databricks auth login --host https://...
databricks sandbox register
databricks sandbox create
databricks sandbox ssh
Configuration du sandbox Databricks
Configurez le nom d'un sandbox et la politique d'arrêt automatique.
Les paramètres --name, --idle-timeout et --no-autostop sont indépendants, et vous pouvez passer n'importe quelle combinaison.
databricks sandbox config <sandbox-id> [flags]
Arguments
<sandbox-id>
L'ID du sandbox à configurer.
Options
--name string
Étiquette pour le sandbox (256 octets max). Passez --name= pour effacer.
--idle-timeout string
Durée du délai d'inactivité. Définissez cette valeur sur 0 (ou 0s) pour l'effacer et utiliser la default du gestionnaire (10m). Plage de valeurs valide : 1m à 24h.
--no-autostop
Lorsque ce paramètre est activé, ce sandbox ne s’arrête jamais automatiquement en cas d’inactivité. Passez --no-autostop=false pour annuler.
Exemples
databricks sandbox config my-sandbox-1234 --name my-project
databricks sandbox config my-sandbox-1234 --idle-timeout 15m
databricks sandbox config my-sandbox-1234 --idle-timeout 1h30m
databricks sandbox config my-sandbox-1234 --idle-timeout 0
databricks sandbox config my-sandbox-1234 --no-autostop
databricks sandbox config my-sandbox-1234 --no-autostop=false
databricks sandbox config my-sandbox-1234 --idle-timeout 30m --no-autostop=false
créer un sandbox Databricks
Créez un nouvel environnement sandbox.
Crée un environnement de développement personnel soutenu par une micro-VM, bloque jusqu’à ce que le sandbox soit en cours d’exécution et imprime l’ID du sandbox.
databricks sandbox create [flags]
Options
--json
Renvoyez les résultats au format JSON.
--name string
Libellé du sandbox (256 octets maximum).
Exemples
databricks sandbox create
databricks sandbox create --name my-project
databricks sandbox create --json
Databricks Sandbox default
Définissez le sandbox par default utilisé par databricks sandbox ssh.
Le default est stocké localement dans ~/.databricks/sandbox.json par profil. L'ID du sandbox est validé par rapport au serveur avant d'être écrit.
databricks sandbox default <sandbox-id> [flags]
Alias : set-default
Arguments
<sandbox-id>
L'ID de sandbox à définir default.
Options
Exemple
databricks sandbox default my-sandbox-1234
databricks sandbox delete
Supprimer un environnement de sandbox.
Ceci met fin et supprime définitivement le sandbox spécifié. La commande invite à une confirmation interactivement ; utilisez --auto-approve pour ignorer l'invite.
databricks sandbox delete <sandbox-id> [flags]
Arguments
<sandbox-id>
L'ID du sandbox à supprimer.
Options
--auto-approve
Ignorer l'invite de confirmation interactive.
Exemples
databricks sandbox delete my-sandbox-1234
databricks sandbox delete my-sandbox-1234 --auto-approve
Liste des sandbox Databricks
Listez vos environnements sandbox.
Affiche toutes les sandboxes associées à votre compte, y compris leur statut actuel et leur ID.
databricks sandbox list [flags]
Options
--json
Renvoyez les résultats au format JSON.
Exemples
databricks sandbox list
databricks sandbox list --json
inscription au sandbox Databricks
Générez une clé SSH dédiée pour le sandbox et enregistrez-la auprès du service.
Cette commande :
- Génère une clé SSH Ed25519 à
~/.ssh/sandbox_ed25519(si elle n’existe pas). - Enregistre la clé publique auprès du service sandbox, étiquetée avec
--name. - Mettez éventuellement à jour
~/.ssh/configavec une entréeHost sandbox-gw.
Après l'enregistrement, databricks sandbox ssh utilise cette clé automatiquement.
databricks sandbox register [flags]
Options
--name string
Étiquette pour la clé enregistrée (correspond par default au hostname de cette machine). Passez --name= pour vous inscrire sans étiquette.
Exemples
databricks sandbox register
databricks sandbox register --name my-laptop
databricks sandbox ssh
Connectez-vous via SSH à votre environnement default ou à un environnement sandbox spécifique. Des arguments supplémentaires après -- sont passés directement à ssh.
databricks sandbox ssh [sandbox-id] [-- <ssh-args-or-command>...] [flags]
Arguments
[sandbox-id]
ID de sandbox facultatif. S'il est omis, il utilise votre default sandbox.
Options
--gateway string
Hostname de passerelle sandbox (détecté automatiquement à partir du profil si vide).
--port string
Port SSH de la passerelle sandbox. Default : 2222.
Exemples
databricks sandbox ssh
databricks sandbox ssh my-sandbox-1234
databricks sandbox ssh -- ls -la /home
databricks sandbox ssh my-sandbox-1234 -- cat /etc/os-release
databricks sandbox ssh -- -L 8080:localhost:8080
clé SSH databricks sandbox
Gérez les clés SSH enregistrées auprès du service sandbox.
databricks sandbox ssh-key [command]
Commandes disponibles
databricks sandbox ssh-key list– Listez les clés SSH enregistrées auprès du service sandbox.databricks sandbox ssh-key delete- Supprimer une clé SSH enregistrée auprès du service sandbox.
Options
liste des clés ssh de sandbox Databricks
Listez les clés SSH enregistrées auprès du service sandbox.
Chaque ligne indique le hachage de clé attribué par le serveur (utilisé pour supprimer la clé), le nom fourni par l'utilisateur, ainsi que les Timestamp de création et de dernière utilisation. La clé enregistrée localement (de databricks sandbox register) est marquée lorsque son hachage correspond à l'une des entrées listées.
databricks sandbox ssh-key list [flags]
Options
--json
Renvoyez les résultats au format JSON.
Exemples
databricks sandbox ssh-key list
databricks sandbox ssh-key list --json
databricks sandbox ssh-key delete
Supprimer une clé SSH enregistrée auprès du service sandbox.
Le hachage de la clé est l'identifiant renvoyé par databricks sandbox ssh-key list. Après suppression, les tentatives de connexion SSH qui utilisent la clé privée correspondante ne fonctionneront pas tant que vous n'aurez pas enregistré la clé de nouveau.
databricks sandbox ssh-key delete <key-hash> [flags]
Arguments
<key-hash>
Le hachage de la clé à supprimer.
Options
Exemple
databricks sandbox ssh-key delete a1b2c3d4e5f6...
databricks sandbox start
Démarrer un environnement sandbox arrêté.
Démarre la micro-VM de soutien et bloque jusqu'à ce que le sandbox atteigne l'état d'exécution (ou jusqu'à 10 minutes). L'exécution de cette commande sur un sandbox déjà en cours d'exécution n'a aucun effet.
databricks sandbox start <sandbox-id> [flags]
Arguments
<sandbox-id>
L'ID du sandbox à activer.
Options
Exemple
databricks sandbox start my-sandbox-1234
statut du sandbox Databricks
Afficher l’état détaillé d’un environnement sandbox.
databricks sandbox status <sandbox-id> [flags]
Arguments
<sandbox-id>
L'ID sandbox à inspecter.
Options
--json
Renvoyez les résultats au format JSON.
Exemples
databricks sandbox status my-sandbox-1234
databricks sandbox status my-sandbox-1234 --json
databricks sandbox stop
Arrêter un environnement sandbox en cours d'exécution.
Met fin au micro-VM sous-jacent, mais préserve l’enregistrement du sandbox et son stockage persistant. L'arrêt d'un sandbox déjà arrêté ne fait rien.
databricks sandbox stop <sandbox-id> [flags]
Arguments
<sandbox-id>
L'ID du sandbox à arrêter.
Options
Exemple
databricks sandbox stop my-sandbox-1234
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