Commandes CLI Databricks

Remarque

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.

Cet article fournit des informations sur les commandes disponibles de l’interface de ligne de commande Databricks. Ces informations viennent en complément de l’aide de la ligne de commande. Pour plus d’informations sur l’installation et l’utilisation de l’interface de ligne de commande (CLI) Databricks, consultez Installer ou mettre à jour l’interface CLI Databricks et Qu’est-ce que l’interface CLI Databricks ?.

L’interface CLI Databricks inclut les groupes de commandes répertoriés dans les tableaux suivants. Les groupes de commandes contiennent des ensembles de commandes connexes, qui peuvent également contenir des sous-commandes. Pour générer des informations d’utilisation et de syntaxe pour un groupe de commandes, une commande individuelle ou une sous-commande :

• databricks <command-group> -h
• databricks <command-group> <command-name> -h
• databricks <command-group> <command-name> <subcommand-name> -h

De nombreuses commandes CLI correspondent aux opérations documentées dans la référence de l’API REST Azure Databricks.

Commandes d’espace de travail

Groupe	Description et commandes
fs	Commandes permettant de gérer les fichiers et le système de fichiers : cat, , cpls, , mkdirrm
git-credentials	Commandes permettant d’inscrire des jetons d’accès personnels pour Databricks afin d’effectuer des opérations pour le compte de l’utilisateur : create, , deleteget, , listupdate
repos	Commandes permettant aux utilisateurs de gérer leurs dépôts Git : create, , deleteget, , listupdate get-permission-levels, , get-permissionsset-permissions, ,update-permissions
secrets	Commandes permettant de gérer les secrets, les étendues de secrets et les autorisations d’accès : create-scope, , delete-acl, , get-acllist-scopesput-acldelete-secretget-secretlist-aclslist-secretsdelete-scopeput-secret
workspace	Commandes pour répertorier, importer, exporter et supprimer des notebooks et des dossiers dans l’espace de travail : delete, export, , get-statusexport-dir, import, import-dir, , list,mkdirs get-permission-levels, , get-permissionsset-permissions, ,update-permissions

Commandes de calcul

Groupe	Description et commandes
cluster-policies	Commandes pour contrôler la possibilité pour vos utilisateurs de configurer des clusters en fonction d'un ensemble de règles : create, , deleteedit, , getlist get-permission-levels, , get-permissionsset-permissions, ,update-permissions
clusters	Commandes vous permettant de créer, de démarrer, de modifier, de lister, d’arrêter et de supprimer des clusters : change-owner, create, deleteediteventsget, , , listlist-node-typeslist-zonespermanent-deletepinresizerestartspark-versionsstartunpin get-permission-levels, , get-permissionsset-permissions, ,update-permissions
global-init-scripts	Commandes permettant aux administrateurs de l’espace de travail de configurer des scripts d’initialisation globaux pour leur espace de travail : create, , deleteget, , listupdate
instance-pools	Commandes pour créer, modifier, supprimer et répertorier des pools d’instances à l’aide d’instances cloud prêtes à l’emploi, ce qui réduit les temps de démarrage et de mise à l’échelle automatique du cluster : create, , deleteedit, , getlist get-permission-levels, , get-permissionsset-permissions, ,update-permissions
instance-profiles	Commandes permettant aux administrateurs d’ajouter, de répertorier et de supprimer des profils d’instance que les utilisateurs peuvent utiliser pour lancer des clusters : add, , editlist, ,remove
libraries	Commandes pour installer, désinstaller et obtenir l’état des bibliothèques sur un cluster : all-cluster-statuses, , cluster-statusinstall, ,uninstall
policy-families	Commandes pour afficher les familles de stratégies disponibles : get, list

Commandes de travaux

Groupe	Description et commandes
jobs	Commandes pour gérer les tâches : cancel-all-runs, cancel-run, , create, delete-rundelete, export-run, getget-runsubmitresetlist-runsrun-nowget-run-outputlistrepair-run,update get-permission-levels, , get-permissionsset-permissions, ,update-permissions

Commandes Delta Live Tables

Groupe	Description et commandes
pipelines	Commandes pour créer, modifier, supprimer, démarrer et afficher des détails sur les pipelines : create, , delete, get-updateget, , list-pipelinesstoplist-updatesstart-updatelist-pipeline-eventsupdate get-permission-levels, , get-permissionsset-permissions, ,update-permissions

Commandes de Machine Learning

Groupe	Description et commandes
experiments	Commandes permettant d’interagir avec les expériences, qui sont la principale unité d’organisation dans MLflow ; toutes les exécutions MLflow appartiennent à une expérience : create-experiment, , delete-experiment, set-tagupdate-experimentcreate-rundelete-rundelete-runsdelete-tagget-by-nameget-experimentget-historyget-runGetlist-artifactslist-experimentslog-batchlog-inputslog-metriclog-modellog-paramrestore-experimentrestore-runrestore-runssearch-experimentssearch-runsset-experiment-tagupdate-run get-permission-levels, , get-permissionsset-permissions, ,update-permissions
model-registry	Commandes pour le registre de modèles d’espace de travail : approve-transition-request, , create-commentcreate-modelcreate-model-versioncreate-transition-requestcreate-webhookdelete-commentdelete-modeldelete-model-tagdelete-model-versiondelete-model-version-tagdelete-transition-requestdelete-webhookget-latest-versionsget-modelget-model-versionget-model-version-download-urilist-modelslist-transition-requestslist-webhooksreject-transition-requestrename-modelsearch-model-versionssearch-modelsset-model-tagset-model-version-tagtest-registry-webhooktransition-stageupdate-commentupdate-modelupdate-model-versionupdate-webhook get-permission-levels, , get-permissionsset-permissions, ,update-permissions

Commandes de service en temps réel

Groupe	Description et commandes
serving-endpoints	Commandes pour créer, mettre à jour et supprimer des points de terminaison de service de modèle : build-logs, , create, , getpatchqueryexport-metricslistlogsputdeleteupdate-config get-permission-levels, , get-permissionsset-permissions, ,update-permissions

Commandes de gestion des identités et des accès

Groupe	Description et commandes
account	Commandes permettant de gérer les comptes Databricks : - Identité et accès : access-control, groups, service-principals, users, workspace-assignment - Unity Catalog : metastore-assignments, metastores, storage-credentials - Paramètres : ip-access-lists, network-connectivity, settings - Approvisionnement : credentials, encryption-keys, networks, private-access, storage, vpc-endpoints, workspaces - Facturation : billable-usage, log-delivery - OAuth : custom-app-integration, o-auth-published-apps, published-app-integration, service-principal-secrets
auth	Commandes pour l’authentification : describe, , envlogin, , profilestoken
current-user	Commandes pour récupérer des informations sur l’utilisateur ou le principal de service actuellement authentifié : me
groups	Commandes pour les groupes simplifiant la gestion des identités, facilitant l’octroi d’accès à l’espace de travail Databricks, aux données et autres objets sécurisables : create, , delete, listget, , patchupdate
permissions	Commandes pour créer, lire, écrire, modifier, mettre à jour et gérer l’accès pour différents utilisateurs sur différents objets et points de terminaison : get, , setupdate get-permission-levels
service-principals	Commandes pour les identités à utiliser avec des travaux, des outils automatisés et des systèmes tels que des scripts, des applications et des plateformes CI/CD : create, , delete, listget, , patchupdate
users	Commandes pour les identités utilisateur reconnues par Databricks et représentées par des adresses e-mail : create, , delete, listget, , patchupdate get-permission-levels, , get-permissionsset-permissions, ,update-permissions

Commandes liées à SQL :

Groupe	Description et commandes
alerts	Commandes pour effectuer des opérations sur les alertes : create, , deleteget, , listupdate
data-sources	Commandes permettant de créer de nouveaux objets de requête : list
queries	Commandes pour effectuer des opérations sur les définitions de requête : create, , delete, listget, , restoreupdate
query-history	Commandes pour accéder à l’historique des requêtes via des entrepôts SQL : list
warehouses	Commandes pour gérer les entrepôts SQL, qui sont une ressource de calcul qui vous permet d’exécuter des commandes SQL sur des objets de données dans Databricks SQL : create, delete, , getedit, get-workspace-warehouse-config, list, set-workspace-warehouse-config, start,stop get-permission-levels, , get-permissionsset-permissions, ,update-permissions

Commandes Unity Catalog

Groupe	Description et commandes
artifact-allowlists	Commandes pour gérer les listes d’autorisation d’artefact. Dans Databricks Runtime 13.3 et les versions ultérieures, vous pouvez ajouter des bibliothèques et des scripts d’initialisation à la liste d'autorisation dans UC afin que les utilisateurs puissent tirer profit de ces artefacts sur le calcul configuré avec le mode d’accès partagé : get, update
catalogs	Commandes pour gérer les catalogues, qui sont la première couche de l’espace de noms à trois niveaux de Unity Catalog : create, , deleteget, , listupdate
connections	Commandes pour créer une connexion à une source de données externe : create, , deleteget, , listupdate
external-locations	Commandes pour gérer les emplacements externes, qui combinent un chemin de stockage cloud avec des informations d'identification de stockage qui autorise l'accès à ce chemin : create, , deleteget, , listupdate
functions	Commandes pour gérer les fonctions définies par l’utilisateur (UDF) dans Unity Catalog : create, , deleteget, , listupdate
grants	Commandes pour accorder l’accès aux données dans Unity Catalog : get, , get-effectiveupdate
metastores	Commandes pour gérer les metastores, qui sont les conteneurs de niveau supérieur des objets dans Unity Catalog : assign, , create, deletecurrent, , listupdatesummaryunassigngetupdate-assignment
model-versions	Commandes pour gérer les versions du modèle. Databricks fournit une version hébergée du registre de modèles MLflow dans Unity Catalog. delete, , getget-by-alias, , listupdate
online-tables	Commandes pour gérer des tables en ligne, qui fournissent une latence plus faible et un accès QPS plus élevé aux données à partir de tables Delta : create, , deleteget
quality-monitors	Commandes pour gérer les moniteurs, qui calculent et surveillent les données ou les métriques de qualité de modèle pour un tableau au fil du temps : create, delete, , get-refreshget, list-refreshes, , run-refresh,update
registered-models	Commandes pour gérer les modèles inscrits. Databricks fournit une version hébergée du registre de modèles MLflow dans Unity Catalog. create, delete, , getdelete-alias, list, , set-alias,update
schemas	Commandes pour gérer les schémas, qui sont la deuxième couche de l’espace de noms à trois niveaux de Unity Catalog : create, , deleteget, , listupdate
storage-credentials	Commandes pour gérer les informations d’identification de stockage, qui représentent un mécanisme d’authentification et d’autorisation pour accéder aux données stockées sur votre locataire cloud : create, , delete, listget, , updatevalidate
system-schemas	Commandes pour gérer les schémas système, qui sont des schémas qui se trouvent dans le catalogue système : disable, , enablelist
table-constraints	Commandes pour gérer les contraintes de clé primaire et de clé étrangère qui encodent les relations entre champs dans les tables : create, delete
tables	Commandes pour gérer les tables, qui résident dans la troisième couche de l’espace de noms à trois niveaux de Unity Catalog : delete, , existsget, , listlist-summaries
volumes	Commandes pour gérer les volumes, qui sont une fonctionnalité de Unity Catalog (UC) pour accéder, stocker, gérer, organiser et traiter des fichiers : create, , deletelist, , readupdate
workspace-bindings	Commandes pour gérer les liaisons d’espace de travail sécurisables. Les éléments sécurisables dans Databricks peuvent être configurés en tant que OPEN ou ISOLATED. get, , get-bindingsupdate, ,update-bindings

Commandes Delta sharing

Groupe	Description et commandes
providers	Commandes pour gérer les fournisseurs de données, qui représentent les organisations qui partagent des données : create, , delete, listget, , list-sharesupdate
recipient-activation	Commandes pour gérer l’activation du destinataire, qui s’applique uniquement dans le modèle de partage ouvert où l’objet destinataire a l’authentification de type TOKEN : get-activation-url-info, retrieve-token
recipients	Commandes pour gérer les destinataires, que vous créez à l'aide de :method:recipients/create pour représenter une organisation dont vous voulez autoriser l’accès aux partages : create, , delete, listget, , rotate-tokenupdate share-permissions
shares	Commandes pour gérer les partages, qui sont des conteneurs instanciés avec :method:shares/create : create, , deleteget, , listupdate share-permissions, update-permissions

Commandes des paramètres

Groupe	Description et commandes
ip-access-lists	Commandes permettant aux administrateurs de configurer des listes d’accès IP : create, , delete, listget, , replaceupdate
settings	Commandes permettant aux utilisateurs de gérer les paramètres au niveau de l’espace de travail : automatic-cluster-update, , csp-enablementdefault-namespace, , esm-enablementrestrict-workspace-admins
token-management	Commandes permettant aux administrateurs d’obtenir tous les jetons et de supprimer des jetons pour d’autres utilisateurs : create-obo-token, , deleteget, ,list get-permission-levels, , get-permissionsset-permissions, ,update-permissions
tokens	Commandes pour créer, répertorier et révoquer des jetons qui peuvent être utilisés pour authentifier les API REST Databricks et y accéder : create, , deletelist
workspace-conf	Commandes pour mettre à jour les paramètres de l’espace de travail : get-status, set-status

Commandes des outils de développement

Groupe	Description et commandes
bundle	Commandes pour gérer les packs de ressources Databricks, qui vous permettent d’exprimer vos projets Databricks sous forme de code : deploy, deployment, , generatedestroy, init, run, schema, sync,validate
sync	Synchronisez un répertoire local avec un répertoire d’espace de travail.

Commandes de recherche vectorielle

Groupe	Description et commandes
vector-search-endpoints	Commandes pour gérer les points de terminaison de recherche vectorielle, qui représentent les ressources de calcul pour héberger des index de recherche vectorielle : create-endpoint, , delete-endpointget-endpoint, ,list-endpoints
vector-search-indexes	Commandes pour gérer les index de recherche vectorielle, qui sont des représentations efficaces de vos vecteurs d’incorporation qui prennent en charge des requêtes efficaces et en temps réel de recherche des plus proches voisins approximatifs : create-index, delete-data-vector-index, , get-indexdelete-index, list-indexes, query-index, , sync-index,upsert-data-vector-index

Commandes de tableau de bord

Groupe	Description et commandes
dashboards	Commandes pour la modification des tableaux de bord : create, , delete, listget, , restoreupdate
lakeview	Commandes qui fournissent des opérations de gestion spécifiques pour les tableaux de bord AI/BI : create, get, , migrateget-published, publish, trash, , unpublish,update

Commandes supplémentaires

Groupe	Description et commandes
api	Commandes pour effectuer des requêtes à l’API REST Databricks : delete, , get, patchhead, , postput
completion	Commandes pour générer un script d’auto-complétion pour l’interpréteur de commandes spécifié : bash, , fishpowershell, ,zsh
configure	Configurer l'interface de ligne de commande Databricks.
help	Informations d’utilisation de sortie pour n’importe quelle commande.
labs	Commandes pour gérer les installations de Databricks Labs : clear-cache, install, , listinstalled, show, , uninstall,upgrade
version	Récupérez la version de l’interface CLI en cours d’utilisation.

Indicateurs généraux

Les indicateurs suivants sont disponibles pour toutes les commandes de l’interface CLI Databricks. Certains indicateurs ne s’appliquent pas à certaines commandes. Pour plus d’informations sur des commandes spécifiques et leurs indicateurs, consultez l’aide sur la ligne de commande.

Indicateur	Description
-h ou --help	Affiche l’aide pour l’interface CLI Databricks, le groupe de commandes associé ou la commande associée.
-e ou --environment string	Chaîne représentant l’environnement groupé à utiliser, le cas échéant, pour la commande associée.
--log-file	Chaîne représentant le fichier d’écriture des journaux de sortie. Si cet indicateur n’est pas spécifié, la valeur par défaut consiste à écrire les journaux de sortie dans stderr.
--log-format	text pour écrire les journaux de sortie au format texte ou json pour écrire les journaux de sortie au format JSON. Si cet indicateur n’est pas spécifié, les journaux de sortie sont écrits au format texte.
--log-level	Chaîne représentant le niveau de format du journal. Si cet indicateur n’est pas spécifié, le niveau de format du journal est désactivé.
-o ou --output	text pour écrire la sortie au format texte ou json pour écrire la sortie au format JSON. Si cet indicateur n’est pas spécifié, la sortie est écrite au format texte.
-p ou --profile	Chaîne représentant le profil de configuration nommé à utiliser dans votre fichier .databrickscfg. Si cet indicateur n’est pas spécifié, le profil nommé DEFAULT est utilisé s’il en existe un. Vous pouvez appuyer sur Tab après --profile ou -p pour afficher une liste de profils de configuration disponibles existants à choisir, au lieu d’entrer manuellement le nom du profil de configuration.
--progress-format	Format des journaux d’avancement à afficher (default (valeur par défaut), append, inplace ou json).