Databricks CLI 命令
本文提供可用 Databricks CLI 命令的相關資訊。 此資訊補充命令列說明。 如需安裝和使用 Databricks CLI 的詳細資訊，請參閱安裝或更新 Databricks CLI 和 什麼是 Databricks CLI？。
Databricks CLI 包含了下表所列的命令群組。 命令群組包含一組相關的命令，也可包含子命令。 要輸出命令群組、個別命令或子命令的使用方式和語法資訊：
databricks <command-group> -hdatabricks <command-group> <command-name> -hdatabricks <command-group> <command-name> <subcommand-name> -h
許多 CLI 命令會對應至 Azure Databricks REST API 參考中記載的作業。
工作區命令
| 群組 |
描述和命令 |
| fs |
用於管理檔案與檔案系統的命令：
cat、、 cp、 ls、 mkdir、 rm |
git-credentials |
註冊 Databricks 個人存取權杖以代表使用者執行作業的命令：
create、、 delete、 get、 list、 update |
repos |
允許使用者管理其 Git 存放庫的命令：
create、、 delete、 get、 list、 update
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions |
secrets |
用於管理祕密、祕密範圍和存取權限的命令：
create-scope、delete-acl、delete-scope、delete-secret、get-acl、get-secretlist-aclslist-scopes、、 list-secretsput-aclput-secret |
workspace |
列出、匯入、匯出及刪除工作區中筆記本和資料夾的命令：
delete、export、export-dir、get-status、import、import-dir、、、 listmkdirs
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions |
計算命令
| 群組 |
描述和命令 |
cluster-policies |
控制使用者根據一組規則設定叢集能力的命令：
create、、 delete、 edit、 get、 list
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions |
clusters |
允許您建立、啟動、編輯、列出、終止和刪除叢集的命令：
change-owner、create、delete、edit、events、getpermanent-deletelistresizepinlist-node-typeslist-zones、restart、、 spark-versionsstartunpin
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions |
global-init-scripts |
可讓工作區系統管理員為其工作區設定全域初始化指令碼的命令：
create、、 delete、 get、 list、 update |
instance-pools |
使用現成可用的雲端執行個體建立、編輯、刪除和列出執行個體集區的命令，可縮短叢集啟動和自動調整時間：
create、、 delete、 edit、 get、 list
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions |
instance-profiles |
可讓系統管理員新增、列出和移除使用者可啟動叢集的執行個體設定檔的命令：
add、 、 edit、 listremove |
libraries |
安裝、卸載和取得叢集上程式庫狀態的命令：
all-cluster-statuses、 、 cluster-status、 installuninstall |
policy-families |
檢視可用原則系列的命令：
get, list |
作業命令
| 群組 |
描述和命令 |
jobs |
管理作業的命令：
cancel-all-runs、cancel-run、create、delete、、export-runget-run-outputgetdelete-runrepair-runlist-runsget-runlist、reset、、 run-nowsubmitupdate
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions |
差異即時資料表命令
| 群組 |
描述和命令 |
pipelines |
用於建立、編輯、刪除、啟動和檢視管線相關詳細資料的命令：
create、delete、get、get-update、list-pipeline-events、list-pipelines、list-updates、、start-update、、 stopupdate
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions |
機器學習命令
| 群組 |
描述和命令 |
experiments |
與實驗互動的命令，實驗是 MLflow 中組織的主要單位；所有 MLflow 執行都屬於實驗：
create-experiment、create-run、delete-experiment、delete-run、 delete-runsdelete-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-permissionsupdate-permissions |
model-registry |
用於工作區模型登錄的命令：
approve-transition-request、create-comment、create-model、create-model-version、 create-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-permissionsupdate-permissions |
即時服務命令
| 群組 |
描述和命令 |
serving-endpoints |
用來建立、更新和刪除服務端點之模型的命令：
build-logs、create、delete、export-metrics、get、listlogspatch、、 putqueryupdate-config
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions |
身分識別和存取權管理命令
| 群組 |
描述和命令 |
account |
用於管理 Databricks 帳戶的命令：
- 身分識別與存取：access-control、groups、service-principals、users、workspace-assignment
- Unity 目錄：metastore-assignments、metastores、storage-credentials
- 設定：ip-access-lists、network-connectivity、settings
- 佈建：credentials、encryption-keys、networks、private-access、storage、vpc-endpoints、workspaces
- 計費：billable-usage、log-delivery
- OAuth：custom-app-integration、o-auth-published-apps、published-app-integration、service-principal-secrets |
| auth |
用於認證的命令：
describe、、 env、 login、 profiles、 token |
current-user |
擷取目前已驗證使用者或服務主體相關資訊的命令：
me |
groups |
群組命令可簡化身分識別管理，讓您更輕鬆地指派對 Databricks 工作區、資料和其他安全性實體物件的存取權：
create、、deleteget、list、、patch、update |
permissions |
針對不同物件和端點上的各種使用者，建立讀取、寫入、編輯、更新及管理存取權的命令：
get、 、 setupdate
get-permission-levels |
service-principals |
服務識別的命令，用於作業、自動化工具和系統，例如指令碼、應用程式和 CI/CD 平台：
create、、deleteget、list、、patch、update |
users |
由 Databricks 辨識並透過電子郵件地址表示的使用者身分識別命令：
create、、deleteget、list、、patch、update
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions |
| 群組 |
描述和命令 |
alerts |
對警示執行作業的命令：
create、、 delete、 get、 list、 update |
data-sources |
建立新查詢物件的命令：
list |
queries |
對查詢定義執行作業的命令：
create、、deleteget、list、、restore、update |
query-history |
透過 SQL 倉儲存取查詢歷程記錄的命令：
list |
warehouses |
管理 SQL 倉儲的命令是一種計算資源，可讓您在 Databricks SQL 內的資料物件上執行 SQL 命令：
create、delete、edit、get、get-workspace-warehouse-config、list、set-workspace-warehouse-config、 startstop
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions |
Unity 目錄命令
| 群組 |
描述和命令 |
artifact-allowlists |
管理成品允許清單的命令。 在 Databricks Runtime 13.3 和更新版本中，可將程式庫和 init 指令碼新增至 UC 中的允許清單，讓使用者可在以共用存取模式設定的計算上運用這些成品：
get, update |
catalogs |
管理目錄的命令，目錄是 Unity 目錄三層命名空間的第一層：
create、、 delete、 get、 list、 update |
connections |
建立外部資料來源連線的命令：
create、、 delete、 get、 list、 update |
external-locations |
管理外部位置的命令，可將雲端儲存體路徑與授權存取雲端儲存體路徑的儲存體認證相結合：
create、、 delete、 get、 list、 update |
functions |
在 Unity 目錄中管理使用者定義函式 (UDF) 的命令：
create、、 delete、 get、 list、 update |
grants |
授與對 Unity 目錄中資料的存取權的命令：
get、 、 get-effectiveupdate |
metastores |
管理中繼存放區的命令，中繼存放區是 Unity 目錄中物件的最上層容器：
assign、create、current、delete、get、list、summary、、unassign、、 updateupdate-assignment |
model-versions |
管理模型版本的命令。 Databricks 提供 Unity 目錄中 MLflow 模型登錄的託管版本。
delete、、 get、 get-by-alias、 list、 update |
online-tables |
管理線上資料表的命令，該資料表可提供較低的延遲和更高的 QPS 來存取差異資料表的資料：
create、 、 deleteget |
quality-monitors |
管理監視器的命令，該監視器可計算和監視一段時間內資料表的資料或模型品質計量：
create、delete、、get-refreshget、list-refreshes、、、 run-refreshupdate |
registered-models |
管理已註冊模型的命令。 Databricks 提供 Unity 目錄中 MLflow 模型登錄的託管版本。
create、delete、、getdelete-alias、list、、、 set-aliasupdate |
schemas |
管理結構描述的命令，結構描述是 Unity 目錄三層命名空間的第二層：
create、、 delete、 get、 list、 update |
storage-credentials |
管理儲存體認證的命令，儲存體認證是存取雲端租用戶上所儲存資料的驗證和授權機制：
create、、deleteget、list、、update、validate |
system-schemas |
用來管理系統結構描述的命令，這些是系統類別目錄中的結構描述：
disable、 、 enablelist |
table-constraints |
管理主索引鍵和外部索引鍵限制式的命令，這些限制式會編碼資料表中欄位之間的關聯性：
create, delete |
tables |
管理資料表的命令，資料表是 Unity 目錄三層命名空間的第三層：
delete、、 exists、 get、 list、 list-summaries |
volumes |
管理磁碟區的命令，這是 Unity 目錄 (UC) 功能，可用來存取、儲存、控管、組織和處理檔案：
create、、 delete、 list、 read、 update |
workspace-bindings |
管理安全性工作區繫結的命令。 Databricks 中安全性實體可設定為 OPEN 或 ISOLATED。
get、 、 get-bindings、 updateupdate-bindings |
差異共用命令
| 群組 |
描述和命令 |
providers |
管理資料提供者的命令，資料提供者代表共用資料的組織：
create、、deleteget、list、、list-shares、update |
recipient-activation |
管理收件者啟用的命令，收件者啟用僅適用於收件者物件具有 TOKEN 驗證類型的開啟共用模型：
get-activation-url-info, retrieve-token |
recipients |
管理收件者的命令，您使用 :method:recipients/create 建立收件者，以代表您想要允許存取共用的組織：
create、、deleteget、list、、rotate-token、update
share-permissions |
shares |
用來管理共用的命令，共用是使用 :method:shares/create 具現的化容器：
create、、 delete、 get、 list、 update
share-permissions, update-permissions |
設定命令
| 群組 |
描述和命令 |
ip-access-lists |
可讓系統管理員設定 IP 存取清單的命令：
create、、deleteget、list、、replace、update |
settings |
允許使用者在工作區層級管理設定的命令：
automatic-cluster-update、、 csp-enablement、 default-namespace、 esm-enablement、 restrict-workspace-admins |
token-management |
可讓系統管理員取得其他使用者所有權杖和刪除權杖的命令：
create-obo-token、 、 delete、 getlist
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions |
tokens |
用來建立、列出和撤銷權杖的命令，該權杖可用來驗證及存取 Databricks REST API：
create、 、 deletelist |
workspace-conf |
更新工作區設定的命令：
get-status, set-status |
| 群組 |
描述和命令 |
| bundle |
管理 Databricks Asset Bundles 組合的命令，可讓您將 Databricks 專案表示為程式碼：
deploy、deployment、destroy、generate、init、run、schema、 syncvalidate |
| sync |
將本機目錄同步至工作區目錄。 |
向量搜尋命令
| 群組 |
描述和命令 |
vector-search-endpoints |
管理向量搜尋端點的命令，向量搜尋端點代表裝載向量搜尋索引的計算資源：
create-endpoint、 、 delete-endpoint、 get-endpointlist-endpoints |
vector-search-indexes |
管理向量搜尋索引的命令，向量搜尋索引是內嵌向量的有效表示法，可支援即時且有效率的近似近鄰 (ANN) 搜尋查詢：
create-index、delete-data-vector-index、delete-index、get-index、list-indexes、query-index、、、 sync-indexupsert-data-vector-index |
儀表板命令
| 群組 |
描述和命令 |
dashboards |
修改儀表板的命令：
create、、deleteget、list、、restore、update |
lakeview |
提供 AI/BI 儀表板特定管理作業的命令：
create、get、get-published、migrate、publish、trash、、、 unpublishupdate |
其他命令
| 群組 |
描述和命令 |
| api |
針對 Databricks REST API 提出要求的命令：
delete、、gethead、patch、、post、put |
| completion |
為指定殼層產生自動完成指令碼的命令：
bash、 、 fish、 powershellzsh |
| 配置 |
設定 Databricks CLI。 |
help |
輸出任何命令的使用方式資訊。 |
| labs |
管理 Databricks Labs 安裝的命令：
clear-cache、install、、listinstalled、show、、、 uninstallupgrade |
version |
擷取目前正在使用的 CLI 版本。 |
全域旗標
下列旗標可供全部 Databricks CLI 命令使用。 請注意，某些旗標不適用於某些命令。 如需特定命令及其旗標的詳細資訊，請參閱命令列說明。
| 旗標 |
描述 |
-h 或 --help |
顯示 Databricks CLI 或相關命令群組或相關命令的說明。 |
-e 或 --environment string |
表示適用於相關命令時要使用的配套環境的字串。 |
--log-file |
表示要寫入輸出記錄檔的字串。 若未指定此旗標，則預設值是將輸出記錄寫入 stderr。 |
--log-format |
text 將輸出記錄寫入文字或 json 將輸出記錄寫入 JSON。 若未指定此旗標，則輸出記錄會寫入為文字。 |
--log-level |
表示記錄格式層級的字串。 若未指定，則會停用記錄格式層級。 |
-o 或 --output |
text 將輸出寫入文字或 json 將輸出寫入為 JSON。 如果未指定此旗標，則輸出會寫入為文字。 |
-p 或 --profile |
表示 .databrickscfg 檔案內要使用的具名組態設定檔的字串。 如果未指定此旗標，若有具名設定檔，則會使用 DEFAULT 具名設定檔。 可以在 --profile 或 -p 之後按 Tab 以顯示現有可用組態設定檔的清單，以從中選擇，而不是手動輸入組態設定檔名稱。 |
--progress-format |
要顯示進度記錄的格式 (default (預設值) 或 append 或 inplace 或 json)。 |