Note
此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態。
Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明，包括任何使用數據條款。
jobs
Databricks CLI 中的指令群組允許你建立、編輯和刪除工作。 請參閱 Lakeflow 職位。
databricks 任務取消所有執行
取消所有正在進行的工作。 執行會以異步方式取消，因此不會防止啟動新的執行。
databricks jobs cancel-all-runs [flags]
Arguments
None
選項
--all-queued-runs
可取消所有佇列執行的選擇性布爾參數。
--job-id int
要取消所有執行運行的工作的標準識別碼。
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
databricks 任務取消執行
取消執行。
取消作業運行或任務運行。 執行會以異步方式取消，因此此要求完成時仍可能仍在執行中。
databricks jobs cancel-run RUN_ID [flags]
Arguments
RUN_ID
此欄位為必要欄位。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--no-wait
不要等到狀態變為 TERMINATED 或 SKIPPED
--timeout duration
到達終止或跳過狀態的最大時間限制（預設為 20 分 0 秒）
databricks 建立任務
建立新工作。
databricks jobs create [flags]
Arguments
None
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
databricks 作業刪除
刪除作業。
databricks jobs delete JOB_ID [flags]
Arguments
JOB_ID
要刪除的工作的正式識別碼。 此欄位為必要欄位。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
databricks 作業 刪除執行情況
刪除非作用中的執行。 如果執行狀態處於作用中，則會傳回錯誤。
databricks jobs delete-run RUN_ID [flags]
Arguments
RUN_ID
要刪除的執行識別碼。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
databricks 作業匯出-執行
匯出和擷取工作執行任務。
databricks jobs export-run RUN_ID [flags]
Arguments
RUN_ID
運行的規範識別碼。 此欄位為必要欄位。
選項
--views-to-export ViewsToExport
要匯出的有哪些檢視。 支援的值：ALL、CODE、DASHBOARDS
databricks 任務獲取
擷取單一作業的詳細數據。
結果中的大型陣列會在超過100個元素時分頁。 單一作業的要求會傳回該作業的所有屬性，以及陣列屬性的前100個元素（工作、作業叢集、環境和參數）。 使用 [next_page_token] 字段來檢查是否有更多結果，並在後續要求中傳遞其值作為page_token。 如果有任何陣列屬性包含超過100個元素，則後續的請求將傳回其他結果。 沒有其他結果的陣列會在稍後的頁面上是空的。
databricks jobs get JOB_ID [flags]
Arguments
JOB_ID
要擷取信息的工作的標準識別碼。 此欄位為必要欄位。
選項
--page-token string
使用從上一個 GetJob 回應中返回的 next_page_token，來請求作業陣列屬性的下一頁。
databricks 作業 get-run
擷取作業執行的元數據。
結果中的大型陣列會在超過100個元素時分頁。 單次執行要求會傳回該執行的所有屬性，以及陣列屬性的前100個元素（tasks、工作集群、工作參數和修復歷史）。 使用 [next_page_token] 字段來檢查是否有更多結果，並在後續要求中傳遞其值作為page_token。 如果有任何陣列屬性包含超過100個元素，則後續的請求將傳回其他結果。 沒有其他結果的陣列會在稍後的頁面上是空的。
databricks jobs get-run RUN_ID [flags]
Arguments
RUN_ID
要擷取其中繼資料的執行的標準識別碼。 此欄位為必要欄位。
選項
--include-history
在回應中包含修復歷程記錄。
--include-resolved-values
在回應中包含已解析的參數值。
--page-token string
使用從上一個 GetRun 回應中傳回的next_page_token，以請求該運行之數組屬性的下一頁。
Databricks 作業獲取運行輸出
擷取單一任務執行的輸出和中繼資料。 當筆記本工作透過 dbutils.notebook.exit（） 呼叫傳回值時，您可以使用此命令來擷取該值。 Databricks 會限制此 API 傳回輸出的前 5 MB。 若要傳回較大的結果，您可以將作業結果儲存在雲端儲存體服務中。
此指令用以驗證 run_id 參數的有效性，若 run_id 參數無效，則回傳 HTTP 狀態碼 400。 這些執行紀錄會在 60 天後自動被移除。 如果您想要在超過 60 天後仍然參考這些結果，您必須在過期之前儲存舊的執行結果。
databricks jobs get-run-output RUN_ID [flags]
Arguments
RUN_ID
運行的規範識別碼。
選項
databricks 作業清單
擷取作業清單。
databricks jobs list [flags]
Arguments
None
選項
--expand-tasks
是否要在回應中包含工作和叢集詳細數據。
--limit int
要傳回的作業數目。
--name string
根據確切（不區分大小寫）作業名稱來篩選清單。
--offset int
要傳回之第一個作業的位移，相對於最近建立的作業。
--page-token string
使用從上一個要求傳回的next_page_token或prev_page_token，分別列出下一頁或上一頁的工作。
databricks 作業列表運行
清單作業會依開始時間以遞減順序執行。
databricks jobs list-runs [flags]
Arguments
None
選項
--active-only
如果active_only為 true，則結果中只會包含作用中的執行;否則，會列出作用中和已完成的執行。
--completed-only
如果 completed_only 為 true，則結果中只會包含已完成的任務;否則，會列出進行中和已完成的任務。
--expand-tasks
是否要在回應中包含工作和叢集詳細數據。
--job-id int
列出將執行的工作。
--limit int
要返回的執行次數。
--offset int
要傳回的第一個執行相對於最近一次執行的偏移量。
--page-token string
使用從上一個要求傳回的next_page_token或prev_page_token，分別列出下一頁或上一頁的執行。
--run-type RunType
要傳回的運行類型。 支援的值：[JOB_RUN、SUBMIT_RUN、WORKFLOW_RUN]
--start-time-from int
顯示從這個值 或之後 啟動的執行。
--start-time-to int
顯示從此值 或之前開始的執行 。
databricks 作業修復-執行
重新執行一或多個作業工作。 工作會在原始作業執行時重新執行。 它們會使用目前的作業和任務設定，而且可以在原始作業運行的歷程記錄中檢視。
databricks jobs repair-run RUN_ID [flags]
Arguments
RUN_ID
要修復之回合的作業執行標識碼。 執行不得進行中。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--latest-repair-id int
最新修復的編號。
--no-wait
不要等到狀態變為 TERMINATED 或 SKIPPED
--performance-target PerformanceTarget
無伺服器作業上的效能模式。 支援的值：[PERFORMANCE_OPTIMIZED，STANDARD]
--rerun-all-failed-tasks
如果為 true，請修復所有失敗的工作。
--rerun-dependent-tasks
如果為 true，請修復所有依賴於 rerun_tasks 中任務的工作，即使它們先前已經成功。
--timeout duration
到達終止或跳過狀態的最大時間限制（預設為 20 分 0 秒）
databricks 任務重設
覆寫指定作業的所有設定。 使用databricks jobs update命令部分更新作業設定。
databricks jobs reset [flags]
Arguments
None
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
databricks 任務立即執行
執行作業，並傳回觸發執行的 run_id。
databricks jobs run-now JOB_ID [flags]
Arguments
JOB_ID
要執行之作業的標識碼
選項
--idempotency-token string
選用的令牌，可保證作業執行請求的等冪性。
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--no-wait
不要等到狀態變為 TERMINATED 或 SKIPPED
--performance-target PerformanceTarget
無伺服器作業上的效能模式。 支援的值：[PERFORMANCE_OPTIMIZED，STANDARD]
--timeout duration
到達終止或跳過狀態的最大時間限制（預設為 20 分 0 秒）
databricks 作業提交
建立並觸發一次性執行的程序。 這可讓您直接提交工作負載，而不需建立任務。
databricks jobs submit [flags]
Note
使用 databricks jobs submit 提交的工作不會被儲存為工作。 它們不會顯示在介面中，失敗時也不會重試。 因為這些資料不會被儲存，Azure Databricks 無法在失敗時自動優化無伺服器運算。 如果你的工作失敗，你可以用經典運算來指定該工作的運算需求。 或者，使用 jobs create 和 jobs run-now 來創建並執行工作。
Arguments
None
選項
--budget-policy-id string
此一次性作業需使用者指定的預算政策ID。
--idempotency-token string
選擇性令牌，可用來保證作業執行要求的等冪性。
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--no-wait
不要等到狀態變為 TERMINATED 或 SKIPPED
--run-name string
執行的名稱（可選）。
--timeout duration
到達終止或跳過狀態的最大時間限制（預設為 20 分 0 秒）
--timeout-seconds int
可選擇的超時設定，可應用於此工作每次的執行。
databricks 任務更新
新增、更新或移除現有作業的特定設定。 使用 reset 覆寫所有作業設定。
databricks jobs update JOB_ID [flags]
Arguments
JOB_ID
要更新的工作的標準識別碼。 此欄位為必要欄位。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
databricks 作業 取得權限層級
取得作業許可權等級。
databricks jobs get-permission-levels JOB_ID [flags]
Arguments
JOB_ID
要取得或管理許可權的工作。
選項
databricks 作業 get-permissions
取得作業的權限。 作業可以從其根對象繼承許可權。
databricks jobs get-permissions JOB_ID [flags]
Arguments
JOB_ID
要取得或管理許可權的工作。
選項
Databricks 工作設定權限
設定作業許可權。
設定物件的許可權，若已有許可權則予以取代。 如果未指定任何許可權，則刪除所有直接許可權。 物件可以從其根對象繼承許可權。
databricks jobs set-permissions JOB_ID [flags]
Arguments
JOB_ID
要取得或管理許可權的工作。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
databricks 任務更新許可權
更新工作上的權限。 作業可以從其根對象繼承許可權。
databricks jobs update-permissions JOB_ID [flags]
Arguments
JOB_ID
要取得或管理許可權的工作。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
全域旗標
--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、、appendinplace、 或json
-t, --target 字串
如果適用，要使用的套件組合目標