Databricks CLI 命令

注意

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览版阶段。

Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明，包括任何数据使用规定。

本文介绍了有关可用的 Databricks CLI 命令的信息。此信息补充了命令行帮助。有关安装和使用 Databricks CLI 的详细信息，请参阅安装或更新 Databricks CLI 和 Databricks CLI。

Databricks CLI 包含下表中列出的命令组。命令组包含相关命令集，这些命令也可以包含子命令。若要输出命令组、单个命令或子命令的使用和语法信息，请使用以下语法：

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

许多 CLI 命令映射到 Azure Databricks REST API 参考中记录的操作。

工作区命令

组	说明和命令
文件系统	用于管理文件和文件系统的命令： `cat`，`cp`，`ls`，`mkdir`，`rm`
git-credentials	用于为 Databricks 注册个人访问令牌以代表用户执行操作的命令： `create`，`delete`，`get`，`list`，`update`
存储库	允许用户管理其 git 存储库的命令： `create`，`delete`，`get`，`list`，`update` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
秘密	用于管理机密、机密范围和访问权限的命令： `create-scope`，`delete-acl`，`delete-scope`，`delete-secret`，`get-acl`，`get-secret`，`list-acls`，`list-scopes`，`list-secrets`，`put-acl`，`put-secret`
工作空间	用于列出、导入、导出和删除工作区中的笔记本和文件夹的命令： `delete`，`export`，`export-dir`，`get-status`，`import`，`import-dir`，`list`，`mkdirs` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

计算命令

组	说明和命令
cluster-policies	用于根据一组规则控制用户配置群集的能力的命令： `create`，`delete`，`edit`，`get`，`list` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
集群	用于创建、启动、编辑、列出、终止和删除群集的命令： `change-owner`，`create`，`delete`，`edit`，`events`，`get`，`list`，`list-node-types`，`list-zones`，`permanent-delete`，`pin`，`resize`，`restart`，`spark-versions`，`start`，`unpin` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
global-init-scripts	使工作区管理员能够为其工作区配置全局初始化脚本的命令： `create`，`delete`，`get`，`list`，`update`
instance-pools	使用现成的云实例创建、编辑、删除和列出实例池的命令，从而缩短群集启动和自动扩展时间： `create`，`delete`，`edit`，`get`，`list` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
instance-profiles	允许管理员添加、列出和删除用户可用来启动群集的实例配置文件的命令： `add`，`edit`，`list`，`remove`
图书馆	用于在群集上安装、卸载和获取库状态的命令： `all-cluster-statuses`，`cluster-status`，`install`，`uninstall`
policy-compliance-for-clusters	用于查看和管理工作区中群集的策略符合性状态的命令： `enforce-compliance`，`get-compliance`，`list-compliance`
policy-families	用于查看可用策略系列的命令： `get`，`list`

作业命令

组	说明和命令
工作	用于管理作业的命令： `cancel-all-runs`，`cancel-run`，`create`，`delete`，`delete-run`，`export-run`，`get`，`get-run`，`get-run-output`，`list`，`list-runs`，`repair-run`，`reset`，`run-now`，`submit`，`update` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
policy-compliance-for-jobs	用于查看和管理工作区中作业的策略符合性状态的命令： `enforce-compliance`，`get-compliance`，`list-compliance`

管道命令

组说明和命令

pipelines 用于修改和管理 Lakeflow Spark 声明性管道管道的命令：
create，delete，get，get-update，list-pipeline-events，list-pipelines，list-updates，start-update，stop，update
get-permission-levels，get-permissions，set-permissions，update-permissions
deploy，destroy，dry-run，generate，history，init，logs，open，run，stop

组	说明和命令
pipelines	用于修改和管理 Lakeflow Spark 声明性管道管道的命令： `create`，`delete`，`get`，`get-update`，`list-pipeline-events`，`list-pipelines`，`list-updates`，`start-update`，`stop`，`update` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions` `deploy`，`destroy`，`dry-run`，`generate`，`history`，`init`，`logs`，`open`，`run`，`stop`

机器学习命令

组	说明和命令
实验	用于与试验交互的命令，这些试验是 MLflow 中组织的主要单元，所有 MLflow 运行都属于试验： `create-experiment`、`create-logged-model`、、`create-run`、 `delete-experimentdelete-logged-modeldelete-logged-model-tagdelete-rundelete-runsdelete-tagfinalize-logged-modelget-by-nameget-experimentget-historyget-logged-modelget-runlist-artifactslist-experimentslog-batchlog-inputslog-logged-model-paramslog-metriclog-modellog-outputslog-paramrestore-experimentrestore-runrestore-runssearch-experimentssearch-logged-modelssearch-runsset-experiment-tagset-logged-model-tagsset-tagupdate-experimentupdate-run` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
特征工程	用于与 Databricks 特征存储的特征交互的命令，Databricks 特征存储为 AI 和 ML 模型中使用的特征提供集中仓库。 `create-feature`，`delete-feature`，`get-feature`，`list-features`，`update-feature`
model-registry	用于工作区模型注册表的命令： `approve-transition-request`，`create-comment`，`create-model`，`create-model-version`，`create-transition-request`，`create-webhook`，`delete-comment`，`delete-model`，`delete-model-tag`，`delete-model-version`，`delete-model-version-tag`，`delete-transition-request`，`delete-webhook`，`get-latest-versions`，`get-model`，`get-model-version`，`get-model-version-download-uri`，`list-models`，`list-transition-requests`，`list-webhooks`，`reject-transition-request`，`rename-model`，`search-model-versions`，`search-models`，`set-model-tag`，`set-model-version-tag`，`test-registry-webhook`，`transition-stage`，`update-comment`，`update-model`，`update-model-version`，`update-webhook` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

实时服务命令

组说明和命令

serving-endpoints 用于创建、更新和删除模型服务终结点的命令：
build-logs，create，create-provisioned-throughput-endpoint，delete，export-metrics，get，get-open-api，list，logs，patch，put，put-ai-gateway，query，update-config，update-notifications，update-provisioned-throughput-endpoint-config
get-permission-levels，get-permissions，set-permissions，update-permissions

组	说明和命令
serving-endpoints	用于创建、更新和删除模型服务终结点的命令： `build-logs`，`create`，`create-provisioned-throughput-endpoint`，`delete`，`export-metrics`，`get`，`get-open-api`，`list`，`logs`，`patch`，`put`，`put-ai-gateway`，`query`，`update-config`，`update-notifications`，`update-provisioned-throughput-endpoint-config` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

标识和访问命令

组	说明和命令
帐户	用于管理 Databricks 帐户的命令：标识和访问：`access-control`、、`groups`、`service-principalsusers`、`workspace-assignment` Unity Catalog：`metastore-assignments`、`metastores`、`storage-credentials` 设置：`ip-access-lists`、、`network-connectivitynetwork-policies`、`settings`、`workspace-network-configuration` 预配：`credentials`、`encryption-keys`、`networks`、`private-access`、`storage`、`vpc-endpoints`、`workspaces` 计费：`billable-usage`、、`budget-policybudgets`、`log-delivery`、`usage-dashboards` OAuth：`custom-app-integration`、、`federation-policy`、`o-auth-published-appspublished-app-integration`、`service-principal-federation-policy`、、`service-principal-secrets`
认证	用于身份验证的命令： `describe`，`login`，`logout`，`profiles`，`switch`，`token`
current-user	用于检索有关当前经过身份验证的用户或服务主体的信息的命令： `me`
组	针对简化标识管理的组的命令，使分配对 Databricks 工作区、数据和其他安全对象的访问权限变得更加容易： `create`，`delete`，`get`，`list`，`patch`，`update`
groups-v2	用于使用更新的 API 管理 Databricks 工作区中的组的命令。组简化了标识管理，以便更轻松地分配对 Databricks 工作区、数据和其他安全对象的访问权限： `create`，`delete`，`get`，`list`，`patch`，`update`
permissions	为不同对象和终结点上的不同用户创建读取、写入、编辑、更新和管理访问权限的命令： `get`，`set`，`update` `get-permission-levels`
service-principal-secrets-proxy	用于在工作区级别管理服务主体机密的命令。使用生成的机密获取服务主体的 OAuth 访问令牌： `create`，`delete`，`list`
service-principals	针对作业、自动化工具和系统（例如脚本、应用程序和 CI/CD 平台）的标识的命令： `create`，`delete`，`get`，`list`，`patch`，`update`
service-principals-v2	用于使用更新的 API 管理服务主体标识的命令，用于作业、自动化工具和系统，例如脚本、应用和 CI/CD 平台： `create`，`delete`，`get`，`list`，`patch`，`update`
用户	针对由 Databricks 识别并由电子邮件地址表示的用户标识的命令： `create`，`delete`，`get`，`list`，`patch`，`update` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
users-v2	用于使用更新的 API 在 Databricks 工作区中管理用户标识的命令： `create`，`delete`，`get`，`list`，`patch`，`update` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

| workspace-iam-v2 |用于管理标识和工作区访问的命令：
get-workspace-access-detail-local、、resolve-group-proxyresolve-service-principal-proxy、、resolve-user-proxy |

组	说明和命令
警报	用于对警报执行操作的命令： `create`，`delete`，`get`，`list`，`update`
alerts-legacy	已弃用。用于对旧版警报执行操作的命令： `create`，`delete`，`get`，`list`，`update`
alerts-v2	用于使用更新的 API 管理 SQL 警报的命令。警报定期运行查询，评估其结果的条件，并在满足条件时通知用户和/或通知目标： `create-alert`，`get-alert`，`list-alerts`，`trash-alert`，`update-alert`
data-sources	已弃用。创建新查询对象的命令： `list`
queries	对查询定义执行操作的命令： `create`，`delete`，`get`，`list`，`restore`，`update`
queries-legacy	已弃用。用于执行旧有查询定义操作的命令： `create`，`delete`，`get`，`list`，`restore`，`update`
query-history	通过 SQL 仓库访问查询历史记录的命令： `list`
仓库	用于管理 SQL 仓库的命令，SQL 仓库是一种计算资源，可让你在 Databricks SQL 中的数据对象上运行 SQL 命令： `create`、`create-default-warehouse-override`、`delete`、`delete-default-warehouse-override`、`edit`、`get`、`get-default-warehouse-override`、`get-workspace-warehouse-config`、`list`、`list-default-warehouse-overrides`、`set-workspace-warehouse-config`、`start`、`stop`、`update-default-warehouse-override` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`

Unity Catalog 命令

组	说明和命令
artifact-allowlists	用于管理项目允许列表的命令。在 Databricks Runtime 13.3 及更高版本中，可以将库和 init 脚本添加到 UC 中的允许列表，以便用户可以在配置了标准访问模式的计算上利用这些项目： `get`，`update`
catalogs	用于管理目录（Unity Catalog 的三级命名空间的第一层）的命令： `create`，`delete`，`get`，`list`，`update`
连接	用于创建与外部数据源的连接的命令： `create`，`delete`，`get`，`list`，`update`
凭据	用于管理凭据的命令，这些凭据是用于访问云租户上的服务的身份验证和授权机制。每个凭据都受 Unity 目录访问控制策略的约束，这些策略控制哪些用户和组可以访问凭据。 `create-credential`，`delete-credential`，`generate-temporary-service-credential`，`get-credential`，`list-credentials`，`update-credential`，`validate-credential`
数据分类	用于管理 Unity 目录的数据分类配置的命令。数据分类自动标识和标记 Unity 目录表中的敏感数据： `create-catalog-config`，`delete-catalog-config`，`get-catalog-config`，`update-catalog-config`
数据质量	用于管理 Unity 目录对象的数据质量的命令（当前支持架构和表）： `cancel-refresh`，`create-monitor`，`create-refresh`，`delete-monitor`，`get-monitor`，`get-refresh`，`list-refresh`，`update-monitor`
entity-tag-assignments	用于跨 Unity 目录实体创建、更新、删除和列出标记分配的命令： `create`，`delete`，`get`，`list`，`update`
external-lineage	用于定义和管理 Databricks 对象与外部系统之间的世系关系的命令： `create-external-lineage-relationship`，`delete-external-lineage-relationship`，`list-external-lineage-relationships`，`update-external-lineage-relationship`
external-locations	用于管理外部位置的命令，外部位置将云存储路径与授权访问云存储路径的存储凭据相结合： `create`，`delete`，`get`，`list`，`update`
external-metadata	用于在 Unity 目录中注册和管理有关外部系统的元数据的命令： `create-external-metadata`，`delete-external-metadata`，`get-external-metadata`，`list-external-metadata`，`update-external-metadata`
functions	用于管理 Unity 目录中的用户定义函数（UDF）的命令： `create`，`delete`，`get`，`list`，`update`
grants	用于授予对 Unity Catalog 中数据的访问权限的命令： `get`，`get-effective`，`update`
元存储	用于管理元存储的命令，元存储是 Unity Catalog 中对象的顶级容器： `assign`，`create`，`current`，`delete`，`get`，`list`，`summary`，`unassign`，`update`，`update-assignment`
model-versions	用于管理模型版本的命令。 Databricks 提供 Unity Catalog 中的 MLflow 模型注册表的托管版本。 `delete`，`get`，`get-by-alias`，`list`，`update`
online-tables	用于管理联机表的命令，通过使用这些表，可在访问 Delta 表中的数据时获享更低延迟和更高的 QPS： `create`，`delete`，`get`
策略	用于管理 Unity 目录中 Attribute-Based 访问控制（ABAC）策略的命令。使用 ABAC 策略时，基于数据属性而不是特定资源控制访问： `create-policy`，`delete-policy`，`get-policy`，`list-policies`，`update-policy`
quality-monitors	用于管理监视器的命令，这些监视器会计算和监视表随时间变化的数据或模型质量指标： `create`，`delete`，`get`，`get-refresh`，`list-refreshes`，`run-refresh`，`update`
quality-monitor-v2	已弃用。用于管理 Unity 目录对象上的数据质量监视器的命令。请改用数据质量： `create-quality-monitor`，`delete-quality-monitor`，`get-quality-monitor`，`list-quality-monitor`，`update-quality-monitor`
registered-models	用于管理已注册模型的命令。 Databricks 提供 Unity Catalog 中的 MLflow 模型注册表的托管版本。 `create`，`delete`，`delete-alias`，`get`，`list`，`set-alias`，`update`
resource-quotas	用于管理 Unity Catalog 在所有可安全访问对象上强制实施的资源配额的命令，这些配额限制可创建的资源数量。 `get-quota`，`list-quotas`
Rfa	允许用户请求访问 Unity 目录安全对象的命令。 `batch-create-access-requests`，`get-access-request-destinations`，`update-access-request-destinations`
schemas	用于管理架构（Unity Catalog 三级命名空间的第二层）的命令： `create`，`delete`，`get`，`list`，`update`
storage-credentials	用于管理存储凭据的命令，存储凭据是用于访问云租户上存储的数据的身份验证和授权机制： `create`，`delete`，`get`，`list`，`update`，`validate`
system-schemas	用于管理系统架构的命令，系统架构系统目录应用的架构： `disable`，`enable`，`list`
table-constraints	用于管理主键和外键约束的命令，这些约束会对表中字段之间的关系进行编码： `create`，`delete`
表格	用于管理表（驻留在 Unity Catalog 的三级命名空间的第三层）的命令： `create`，`delete`，`exists`，`get`，`list`，`list-summaries`
temporary-path-credentials	用于管理临时路径凭据的命令，这些凭据是生存期较短的缩减凭据，用于访问 Databricks 中注册的外部云存储位置。 `generate-temporary-path-credentials`
temporary-table-credentials	用于管理临时表凭据的命令，这些凭据是短期有效且权限受限的凭据，用于访问存储在 Databricks 中的云存储位置。 `generate-temporary-table-credentials`
volumes	用于管理卷的命令，卷是 Unity Catalog (UC) 用于访问、存储、管理、组织和处理文件的功能： `create`，`delete`，`list`，`read`，`update`
workspace-bindings	用于管理安全工作区绑定的命令。可以将 Databricks 中的安全对象配置为 `OPEN` 或 `ISOLATED`。 `get`，`get-bindings`，`update`，`update-bindings`

标记命令

组	说明和命令
tag-policies	用于管理 Databricks 中受治理标记的策略的命令： `create-tag-policy`，`delete-tag-policy`，`get-tag-policy`，`update-tag-policy`
workspace-entity-tag-assignments	用于管理工作区范围内对象的标记分配的命令： `create-tag-assignment`，`delete-tag-assignment`，`get-tag-assignment`，`list-tag-assignment`，`update-tag-assignment`

组	说明和命令
供应商	用于管理数据提供程序的命令，这些提供程序表示共享数据的组织： `create`，`delete`，`get`，`list`，`list-shares`，`update`
recipient-activation	管理接收者激活的命令，仅适用于对接收者对象采用 TOKEN 身份验证类型的开放共享模型： `get-activation-url-info`，`retrieve-token`
recipients	管理接收者的命令，你可以使用 `:method:recipients/create` 创建这些接收者，用其来代表你想要允许访问共享内容的组织： `create`，`delete`，`get`，`list`，`rotate-token`，`update` `share-permissions`
recipient-federation-policies	用于在开放式共享模型中管理 OIDC 收件人的联合策略的命令： `create`，`delete`，`get-federation-policy`，`list`
股票	用于管理共享的命令，这些共享是使用 `:method:shares/create` 实例化的容器： `create`，`delete`，`get`，`list`，`list-shares`，`update` `share-permissions`，`update-permissions`

设置命令

组	说明和命令
ip-access-lists	用于使管理员能够配置 IP 访问列表的命令： `create`，`delete`，`get`，`list`，`replace`，`update`
notification-destinations	用于管理工作区通知接收端的命令： `create`，`delete`，`get`，`list`，`update`
设置	用于允许用户在工作区级别管理设置的命令： `automatic-cluster-update`，`csp-enablement`，`default-namespace`，`esm-enablement`，`restrict-workspace-admins`
token-management	允许管理员获取所有令牌并删除其他用户的令牌的命令： `create-obo-token`，`delete`，`get`，`list` `get-permission-levels`，`get-permissions`，`set-permissions`，`update-permissions`
令牌	用于创建、列出和撤销令牌的命令，这些令牌可用于对 Databricks REST API 进行身份验证和访问： `create`，`delete`，`list`
workspace-conf	用于更新工作区设置的命令： `get-status`，`set-status`
workspace-settings-v2	使用更新的 API 管理工作区级设置的命令： `get-public-workspace-setting`，`list-workspace-settings-metadata`，`patch-public-workspace-setting`

开发人员工具命令

组	说明和命令
包	用于管理声明性自动化捆绑包的命令，可让你将 Databricks 项目表示为代码： `deploy`、、`deployment`、`destroygenerate`、`init`、`openplanrunschema`、`summary`、、 `syncvalidate`
同步	将本地目录同步到工作区目录。

仪表板命令

组	说明和命令
湖景	为 AI/BI 仪表板提供特定管理操作的命令： `create`、`create-schedule`、`create-subscription`、`delete-schedule`、`delete-subscription`、`get`、`get-published`、`get-schedule`、`get-subscription`、`list`、`list-schedules`、`list-subscriptions`、`migrate`、`publish`、`trash`、`unpublish`、`update`、`update-schedule`
lakeview-embedded	用于在外部应用程序中嵌入 AI/BI 仪表板的基于令牌的 Lakeview API 的命令： `get-published-dashboard-token-info`

其他命令

组	说明和命令
api	用于向 Databricks REST API 发出请求的命令： `delete`，`get`，`head`，`patch`，`post`，`put`
完成	用于为指定的 shell 生成自动补全脚本的命令： `bash`，`fish`，`powershell`，`zsh`
配置	配置 Databricks CLI。
`help`	所有 Databricks CLI 命令的输出摘要信息。
实验室	用于管理 Databricks Labs 安装的命令： `clear-cache`，`install`，`installed`，`list`，`show`，`uninstall`，`upgrade`
版本	检索当前使用的 CLI 版本。

全局标志

以下标志可用于所有 Databricks CLI 命令。请注意，某些标志不适用于某些命令。有关特定命令及其标记的详细信息，请参阅命令行帮助。

--debug

是否启用调试日志记录。

-h 或 --help

显示 Databricks CLI、相关命令组或相关命令的帮助。

--log-file 字符串

一个字符串，表示要将输出日志写入到的文件。如果未指定此标志，则默认会将输出日志写入到 stderr。

--log-format 格式

日志格式类型，text 或 json。默认值是 text。

--log-level 字符串

一个表示日志格式级别的字符串。如果未指定，则禁用日志格式级别。

-o, --output 类型

命令输出类型为 text 或 json。默认值是 text。

-p, --profile 字符串

要用于运行命令的 ~/.databrickscfg 文件中的配置文件名称。如果未指定此标志，并且存在命名为 DEFAULT 的配置文件，则使用该配置文件。

--progress-format 格式

显示进度日志的格式： default、 append、 inplace或 json

-t, --target 字符串

如果适用，要使用的捆绑包目标

Last updated on 2026-05-08