Comandos de la CLI de Databricks

2025-05-14

Nota:

Esta información se aplica a las versiones 0.205 y posteriores de la CLI de Databricks. La CLI de Databricks está en versión preliminar pública.

El uso de la CLI de Databricks está sujeto a la licencia de Databricks y al aviso de privacidad de Databricks, incluidas las disposiciones de datos de uso.

En este artículo se proporciona información sobre los comandos disponibles de la CLI de Databricks. Esta información complementa la ayuda de la línea de comandos. Para obtener más información sobre cómo instalar y usar la CLI de Databricks, consulte Instalación o actualización de la CLI de Databricks y ¿Qué es la CLI de Databricks?.

La CLI de Databricks incluye los grupos de comandos enumerados en las tablas siguientes. Los grupos de comandos contienen conjuntos de comandos relacionados, que también pueden contener subcomandos. Para generar información de uso y sintaxis de un grupo de comandos, un comando individual o un subcomando:

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

Muchos comandos de la CLI se asignan a las operaciones documentadas en Referencia de la API de REST de Azure Databricks.

Comandos del área de trabajo

Grupo	Descripción y comandos
Fs	Comandos para administrar archivos y el sistema de archivos: `cat`, `cp`, `ls`, , `mkdir`, `rm`
`git-credentials`	Comandos para registrar tokens de acceso personal para que Databricks realice operaciones en nombre del usuario: `create`, `delete`, `get`, , `list`, `update`
`repos`	Comandos para permitir que los usuarios administren sus repositorios de Git: `create`, `delete`, `get`, , `list`, `update` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`
`secrets`	Comandos para administrar secretos, ámbitos secretos y permisos de acceso: `create-scope`, `delete-acl`, `delete-scope`, `delete-secret`, `get-acl`, `get-secret`, `list-acls`, `list-scopes`, `list-secrets`, , `put-aclput-secret`
`workspace`	Comandos para enumerar, importar, exportar y eliminar cuadernos y carpetas en el área de trabajo: `delete`, `export`, `export-dir`, `get-status`, `import`, `import-dir`, , `listmkdirs` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`

Comandos de proceso

Grupo	Descripción y comandos
`cluster-policies`	Comandos para controlar la capacidad de los usuarios de configurar clústeres en función de un conjunto de reglas: `create`, `delete`, `edit`, , `get`, `list` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`
`clusters`	Comandos que permiten crear, iniciar, editar, enumerar, finalizar y eliminar clústeres: `change-owner`, `create`, `delete`, `edit`, , `events`, `get`, `listlist-node-typeslist-zonespermanent-deletepinresizerestartspark-versionsstartunpin` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`
`global-init-scripts`	Comandos que permiten a los administradores del área de trabajo configurar scripts de inicialización global para su área de trabajo: `create`, `delete`, `get`, , `list`, `update`
`instance-pools`	Comandos para crear, editar, eliminar y enumerar grupos de instancias mediante instancias en la nube listas para usar, lo que reduce los tiempos de inicio y escalado automático del clúster: `create`, `delete`, `edit`, , `get`, `list` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`
`instance-profiles`	Comandos para permitir a los administradores agregar, enumerar y quitar perfiles de instancia con los que los usuarios pueden iniciar clústeres con: `add`, `edit`, , `list`, `remove`
`libraries`	Comandos para instalar, desinstalar y obtener el estado de las bibliotecas en un clúster: `all-cluster-statuses`, `cluster-status`, , `install`, `uninstall`
`policy-families`	Comandos para ver las familias de directivas disponibles: `get`, `list`

Comandos de trabajos

Grupo	Descripción y comandos
`jobs`	Comandos para administrar trabajos: `cancel-all-runs`, `cancel-run`, `create`, `delete`, , `delete-runexport-run`, `get`, `get-run`, `get-run-outputlistlist-runsrepair-runresetrun-nowsubmitupdate` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`

Comandos de canalizaciones declarativas de Lakeflow

Grupo	Descripción y comandos
`pipelines`	Comandos para crear, editar, eliminar, iniciar y ver detalles sobre las canalizaciones: `create`, `delete`, `get`, `get-update`, `list-pipeline-events`, `list-pipelines`, `list-updates`, `start-update`, , `stopupdate` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`

Comandos de Machine Learning

Grupo Descripción y comandos

experiments Comandos para interactuar con experimentos, que son la unidad principal de la organización en MLflow; todas las ejecuciones de MLflow pertenecen a un experimento:
create-experiment, create-run, delete-experiment, delete-run, delete-runs, delete-tagget-by-nameget-experimentget-historyget-runGetlist-artifactslist-experimentslog-batchlog-inputslog-metriclog-modellog-paramrestore-experimentrestore-runrestore-runssearch-experimentssearch-runsset-experiment-tagset-tagupdate-experimentupdate-run
get-permission-levels, get-permissions, , set-permissions, update-permissions

model-registry Comandos para el Registro de modelos del área de trabajo:
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-permissions, , set-permissions, update-permissions

Grupo	Descripción y comandos
`experiments`	Comandos para interactuar con experimentos, que son la unidad principal de la organización en MLflow; todas las ejecuciones de MLflow pertenecen a un experimento: `create-experiment`, `create-run`, `delete-experiment`, `delete-run`, `delete-runs`, `delete-tagget-by-nameget-experimentget-historyget-runGetlist-artifactslist-experimentslog-batchlog-inputslog-metriclog-modellog-paramrestore-experimentrestore-runrestore-runssearch-experimentssearch-runsset-experiment-tagset-tagupdate-experimentupdate-run` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`
`model-registry`	Comandos para el Registro de modelos del área de trabajo: `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-permissions`, , `set-permissions`, `update-permissions`

Comandos de servicio en tiempo real

Grupo	Descripción y comandos
`serving-endpoints`	Comandos para crear, actualizar y eliminar puntos de conexión de servicio del modelo: `build-logs`, `create`, `delete`, `export-metrics`, `get`, `list`, `logs`, `patch`, `put`, , `queryupdate-config` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`

Comandos de administración de identidades y acceso

Grupo	Descripción y comandos
`account`	Comandos para administrar cuentas de Databricks: Identidad y acceso: `access-control`, `groups`, `service-principals`, , `usersworkspace-assignment` Catálogo de Unity: `metastore-assignments`, `metastores`, `storage-credentials` Configuración: `ip-access-lists`, `network-connectivity`, `settings` Aprovisionamiento: `credentials`, `encryption-keys`, `networks`, `private-access`, `storage`, `vpc-endpointsworkspaces` Facturación: `billable-usage`, `log-delivery` OAuth: `custom-app-integration`, `o-auth-published-apps`, `published-app-integration`, , `service-principal-secrets`
Auth	Comandos para la autenticación: `describe`, `env`, `login`, , `profiles`, `token`
`current-user`	Comandos para recuperar información sobre el usuario o la entidad de servicio autenticados actualmente: `me`
`groups`	Comandos para grupos que simplifican la administración de identidades, lo que facilita la asignación de acceso al área de trabajo de Databricks, a los datos y a otros objetos protegibles: `create`, `delete`, `get`, `list`, , `patch`, `update`
`permissions`	Comandos para crear acceso de lectura, escritura, edición, actualización y administración para varios usuarios en distintos objetos y puntos de conexión: `get`, , `set`, `update` `get-permission-levels`
`service-principals`	Comandos para identidades para su uso con trabajos, herramientas automatizadas y sistemas como scripts, aplicaciones y plataformas de CI/CD: `create`, `delete`, `get`, `list`, , `patch`, `update`
`users`	Comandos para identidades de usuario reconocidas por Databricks y representadas por direcciones de correo electrónico: `create`, `delete`, `get`, `list`, , `patch`, `update` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`

Grupo	Descripción y comandos
`alerts`	Comandos para realizar operaciones en alertas: `create`, `delete`, `get`, , `list`, `update`
`alerts-legacy`	Comandos para realizar operaciones sobre alertas antiguas. `create`, `delete`, `get`, , `list`, `update`
`data-sources`	Comandos para crear nuevos objetos de consulta: `list`
`queries`	Comandos para realizar operaciones en definiciones de consulta: `create`, `delete`, `get`, `list`, , `restore`, `update`
`queries-legacy`	Comandos para realizar operaciones en definiciones de consulta heredadas: `create`, `delete`, `get`, `list`, , `restore`, `update`
`query-history`	Comandos para acceder al historial de consultas a través de almacenes de SQL: `list`
`warehouses`	Comandos para administrar almacenes de SQL, que son un recurso de proceso que permite ejecutar comandos SQL en objetos de datos dentro de Databricks SQL: `create`, `delete`, `edit`, `get`, `get-workspace-warehouse-config`, `list`, `set-workspace-warehouse-config`, , `startstop` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`

Comandos del catálogo de Unity

Grupo	Descripción y comandos
`artifact-allowlists`	Comandos para administrar listas de permitidos de artefactos. En Databricks Runtime 13.3 y versiones posteriores, puede agregar bibliotecas e scripts de inicialización a la lista de permitidos en UC para que los usuarios puedan aprovechar estos artefactos en el proceso configurado con el modo de acceso estándar: `get`, `update`
`catalogs`	Comandos para administrar catálogos, la primera capa del espacio de nombres de tres niveles de Unity Catalog: `create`, `delete`, `get`, , `list`, `update`
`credentials`	Comandos para administrar credenciales, que son el mecanismo de autenticación y autorización para acceder a los servicios en el inquilino en la nube. Cada credencial está sujeta a directivas de control de acceso del Catálogo de Unity que controlan qué usuarios y grupos pueden acceder a la credencial. `create-credential`, `delete-credential`, `generate-temporary-service-credential`, `get-credential`, `list-credentials`, , `update-credentialvalidate-credential`
`connections`	Comandos para crear una conexión a un origen de datos externo: `create`, `delete`, `get`, , `list`, `update`
`external-locations`	Comandos para administrar ubicaciones externas, que combinan una ruta de acceso de almacenamiento en la nube con una credencial de almacenamiento que autoriza el acceso a la ruta de acceso de almacenamiento en la nube: `create`, `delete`, `get`, , `list`, `update`
`functions`	Comandos para administrar funciones definidas por el usuario (UDF) en el catálogo de Unity: `create`, `delete`, `get`, , `list`, `update`
`grants`	Comandos para conceder acceso a los datos en el Catálogo de Unity: `get`, , `get-effective`, `update`
`metastores`	Comandos para administrar metastores, que son el contenedor de nivel superior de objetos en el catálogo de Unity: `assign`, `create`, `current`, `delete`, `get`, `list`, `summary`, `unassign`, , `updateupdate-assignment`
`model-versions`	Comandos para administrar las versiones del modelo. Databricks proporciona una versión hospedada del Registro de modelos de MLflow en Unity Catalog. `delete`, `get`, `get-by-alias`, , `list`, `update`
`online-tables`	Comandos para administrar tablas en línea, que proporcionan una menor latencia y un mayor acceso de QPS a los datos de tablas delta: `create`, , `delete`, `get`
`quality-monitors`	Comandos para administrar monitores, que calculan y supervisan las métricas de calidad de datos o modelos de una tabla a lo largo del tiempo: `create`, `delete`, `get`, `get-refresh`, `list-refreshes`, , `run-refreshupdate`
`registered-models`	Comandos para administrar modelos registrados. Databricks proporciona una versión hospedada del Registro de modelos de MLflow en Unity Catalog. `create`, `delete`, `delete-alias`, `get`, `list`, , `set-aliasupdate`
`resource-quotas`	Comandos para administrar las cuotas de recursos que aplica Unity Catalog en todos los objetos protegibles, que limitan el número de recursos que se pueden crear. `get-quota`, `list-quotas`
`schemas`	Comandos para administrar esquemas, que son la segunda capa del espacio de nombres de tres niveles de Unity Catalog: `create`, `delete`, `get`, , `list`, `update`
`storage-credentials`	Comandos para administrar las credenciales de almacenamiento, que son un mecanismo de autenticación y autorización para acceder a los datos almacenados en el inquilino en la nube: `create`, `delete`, `get`, `list`, , `update`, `validate`
`system-schemas`	Comandos para administrar esquemas del sistema, que son esquemas que residen en el catálogo del sistema: `disable`, , `enable`, `list`
`table-constraints`	Comandos para administrar restricciones de clave principal y clave externa que codifican relaciones entre campos en tablas: `create`, `delete`
`tables`	Comandos para administrar tablas, que residen en la tercera capa del espacio de nombres de tres niveles del catálogo de Unity: `delete`, `exists`, `get`, , `list`, `list-summaries`
`temporary-table-credentials`	Comandos para administrar las credenciales de tabla temporales, que son credenciales de corta duración y con ámbito descendente que se usan para acceder a ubicaciones de almacenamiento en la nube donde se almacenan los datos de tabla en Databricks. `generate-temporary-table-credentials`
`volumes`	Comandos para administrar volúmenes, que son una funcionalidad de Catálogo de Unity (UC) para acceder, almacenar, gobernar, organizar y procesar archivos: `create`, `delete`, `list`, , `read`, `update`
`workspace-bindings`	Comandos para administrar enlaces de área de trabajo protegibles. Los elementos protegibles de Databricks se pueden configurar como `OPEN` o `ISOLATED`. `get`, `get-bindings`, , `update`, `update-bindings`

Grupo	Descripción y comandos
`providers`	Comandos para administrar proveedores de datos, que representan a las organizaciones que comparten datos: `create`, `delete`, `get`, `list`, , `list-shares`, `update`
`recipient-activation`	Comandos para administrar la activación de destinatarios, que solo es aplicable en el modelo de uso compartido abierto en el que el objeto destinatario tiene el tipo de autenticación TOKEN: `get-activation-url-info`, `retrieve-token`
`recipients`	Comandos para administrar destinatarios, que se crean mediante `:method:recipients/create` para representar una organización que desea permitir el acceso a recursos compartidos: `create`, `delete`, `get`, `list`, , `rotate-token`, `update` `share-permissions`
`shares`	Comandos para administrar recursos compartidos, que son contenedores creados con `:method:shares/create`: `create`, `delete`, `get`, , `list`, `update` `share-permissions`, `update-permissions`

Comandos de configuración

Grupo	Descripción y comandos
`ip-access-lists`	Comandos para habilitar que los administradores configuren listas de acceso IP: `create`, `delete`, `get`, `list`, , `replace`, `update`
`notification-destinations`	Comandos para administrar los destinos de notificación de un área de trabajo: `create`, `delete`, `get`, , `list`, `update`
`settings`	Comandos para permitir a los usuarios administrar la configuración en el nivel de área de trabajo: `automatic-cluster-update`, `csp-enablement`, `default-namespace`, , `esm-enablement`, `restrict-workspace-admins`
`token-management`	Comandos que permiten a los administradores obtener todos los tokens y eliminar tokens para otros usuarios: `create-obo-token`, `delete`, , `get`, `list` `get-permission-levels`, `get-permissions`, , `set-permissions`, `update-permissions`
`tokens`	Comandos para crear, enumerar y revocar tokens que se pueden usar para autenticar y acceder a las APIde REST de Databricks: `create`, , `delete`, `list`
`workspace-conf`	Comandos para actualizar la configuración del área de trabajo: `get-status`, `set-status`

Comandos de herramientas de desarrollo

Grupo	Descripción y comandos
Agrupación	Comandos para administrar Conjuntos de recursos de Databricks, lo que le permite expresar los proyectos de Databricks como código: `deploy`, `deployment`, `destroy`, `generate`, `init`, `open`, `run`, `schema`, `summary`, , `syncvalidate`
Sincronizar	Sincronice un directorio local con un directorio del área de trabajo.

Comandos de vector de búsqueda

Grupo	Descripción y comandos
`vector-search-endpoints`	Comandos para administrar puntos de conexión de vector de búsqueda, que representan los recursos de proceso para hospedar índices de búsqueda vectorial: `create-endpoint`, `delete-endpoint`, , `get-endpoint`, `list-endpoints`
`vector-search-indexes`	Comandos para administrar índices de vector de búsqueda, una representación eficaz de los vectores de inserción que admiten consultas de búsqueda cercanas (ANN) más cercanas en tiempo real y eficaces: `create-index`, `delete-data-vector-index`, `delete-index`, `get-index`, `list-indexes`, `query-index`, , `sync-indexupsert-data-vector-index`

Comandos del panel

Grupo	Descripción y comandos
`dashboards`	Comandos para modificar paneles de control antiguos `create`, `delete`, `get`, `list`, , `restore`, `update`
`genie`	Comandos para modificar Genie, que proporciona una experiencia sin código para los usuarios empresariales, con tecnología de IA/BI: `create-message`, `execute-message-attachment-query`, `get-message`, `get-message-attachment-query-result`, , `get-spaced`, `start-conversation`
`lakeview`	Comandos que proporcionan operaciones de administración específicas para los paneles de IA/BI: `create`, `create-schedule`, `create-subscription`, `delete-schedule`, , `getdelete-subscriptionget-publishedget-scheduleget-subscriptionlistlist-scheduleslist-subscriptionsmigratepublishtrashunpublishupdateupdate-schedule`

Comandos de Marketplace

Grupo	Descripción y comandos
`consumer-fulfillments`	Comandos para administrar las gestiones de cumplimientos, que son entidades que permiten a los consumidores obtener una vista previa de las instalaciones. `get`, `list`
`consumer-installations`	Comandos para administrar instalaciones, que son entidades que permiten a los consumidores interactuar con los listados del Marketplace de Databricks. `create`, `delete`, `list`, , `list-listing-installations`, `update`
`consumer-listings`	Comandos para administrar listas de consumidores de Marketplace de Databricks: `batch-get`, `get`, , `list`, `search`
`consumer-personalization-requests`	Comandos para administrar solicitudes de personalización, que permiten a los clientes interactuar con el flujo de listado individualizado de Marketplace. `create`, , `get`, `list`
`consumer-providers`	Comandos para administrar proveedores, que son las entidades que publican listados en Marketplace. `batch-get`, , `get`, `list`
`provider-exchange-filters`	Comandos para administrar filtros de intercambio de Marketplace, que administran qué grupos pueden acceder a un intercambio. `create`, `delete`, , `list`, `update`
`provider-exchanges`	Comandos para administrar intercambios de Marketplace, que permiten a los proveedores compartir sus listados con un conjunto mantenido de clientes. `add-listing-to-exchange`, `create`, `delete`, `delete-listing-from-exchange`, `get`, `list`, `list-exchanges-for-listing`, , `list-listings-for-exchangeupdate`
`provider-files`	Comandos para administrar archivos de Marketplace, como cuadernos de vista previa e iconos de proveedor. `create`, `delete`, , `get`, `list`
`provider-listings`	Comandos para administrar listas de proveedores: `create`, `delete`, `get`, , `list`, `update`
`provider-personalization-requests`	Comandos para administrar solicitudes de personalización, que son una alternativa a las listas disponibles al instante. `list`, `update`
`provider-provider-analytics-dashboards`	Comandos para administrar el análisis con plantilla para proveedores: `create`, `get`, , `get-latest-version`, `update`
`provider-providers`	Comandos para administrar proveedores, que administran recursos en Marketplace. `create`, `delete`, `get`, , `list`, `update`

Comandos de aplicaciones

Grupo	Descripción y comandos
`apps`	Comandos para administrar aplicaciones de Databricks, que se ejecutan directamente en la instancia de Databricks, se integran con los datos, usan y extienden los servicios de Databricks y permiten a los usuarios interactuar a través del inicio de sesión único. `create`, `delete`, `deploy`, `get`, `get-deployment`, `list`, `list-deployments`, `run-local`, `start`, , `stopupdate`

Comandos de salas limpias

Grupo	Descripción y comandos
`clean-room-assets`	Comandos para administrar recursos de sala limpia, que son datos y objetos de código, como tablas, volúmenes y cuadernos que se comparten con la sala limpia. `create`, `delete`, `get`, , `list`, `update`
`clean-room-task-runs`	Comandos para gestionar las ejecuciones de tareas en un entorno de sala limpia, que son las ejecuciones de cuadernos en dicho entorno. `list`
`clean-rooms`	Comandos para administrar salas limpias. Las salas limpias usan Delta Sharing y computación sin servidor para proporcionar un entorno seguro que proteja la privacidad, donde varias partes pueden trabajar en datos empresariales confidenciales sin acceso directo a los datos de los demás. `create`, `create-output-catalog`, `delete`, `get`, , `list`, `update`

Comandos adicionales

Grupo	Descripción y comandos
API	Comandos para realizar solicitudes a la API de REST de Databricks: `delete`, `get`, `head`, `patch`, , `post`, `put`
terminación	Comandos para generar el script de autocompletar para el shell especificado: `bash`, `fish`, , `powershell`, `zsh`
configurar	Configure la CLI de Databricks.
`help`	Información de uso de salida para cualquier comando.
laboratorios de	Comandos para administrar instalaciones de Databricks Labs: `clear-cache`, `install`, `installed`, `list`, `show`, , `uninstallupgrade`
`version`	Recupere la versión de la CLI que se está usando actualmente.

Marcas globales

Las marcas siguientes están disponibles para todos los comandos de la CLI de Databricks. Tenga en cuenta que algunas marcas no se aplican a algunos comandos. Para obtener información detallada sobre comandos específicos y sus marcas, consulte la ayuda de la línea de comandos.

Marca	Descripción
`-h` o `--help`	Mostrar ayuda para la CLI de Databricks o el grupo de comandos relacionado o el comando relacionado.
`-e` o `--environment string`	Cadena que representa el entorno de agrupación que se va a usar si procede para el comando relacionado.
`--log-file`	Cadena que representa el objeto en el que se van a escribir los registros de salida. Si no se especifica esta marca, el valor predeterminado es escribir registros de salida en stderr.
`--log-format`	`text` para escribir registros de salida en texto o `json` para escribir registros de salida en JSON. Si no se especifica esta marca, los registros de salida se escriben como texto.
`--log-level`	Cadena que representa el nivel de formato de registro. Si no se especifica, el nivel de formato de registro está deshabilitado.
`-o` o `--output`	`text` para escribir la salida como texto o `json` para escribir la salida como JSON. Si no se especifica esta marca, la salida se escribe como texto.
`-p` o `--profile`	Cadena que representa el perfil de configuración con nombre que se va a usar en el `.databrickscfg` archivo. Si no se especifica esta bandera, se utiliza el perfil nombrado `DEFAULT`, si existe. Puede presionar `Tab` después de `--profile` o `-p` para mostrar una lista de perfiles de configuración disponibles entre los que elegir, en lugar de escribir manualmente el nombre del perfil de configuración.
`--progress-format`	Formato de los registros de progreso que se van a mostrar (`default` (valor predeterminado) o `append` o `inplace` o `json`).