次の方法で共有


jobs コマンド グループ

Note

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です

Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。

jobs 内の コマンド グループを使用すると、ジョブを作成、編集、および削除できます。 Lakeflow ジョブを参照してください。

databricks のジョブの実行をすべてキャンセル

ジョブのアクティブな実行をすべて取り消します。 実行は非同期的に取り消されるため、新しい実行が開始されるのを防ぐことはありません。

databricks jobs cancel-all-runs [flags]

Arguments

None

オプション

--all-queued-runs

    キューに登録されているすべての実行を取り消す省略可能なブール値パラメーター。

--job-id int

    実行をすべて取り消すジョブの正規識別子。

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

Databricks ジョブの実行キャンセル

実行を取り消します。

ジョブ実行またはタスク実行をキャンセルします。 実行は非同期的に取り消されるため、この要求が完了しても実行されている可能性があります。

databricks jobs cancel-run RUN_ID [flags]

Arguments

RUN_ID

    このフィールドは必須です。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--no-wait

    TERMINATED または SKIPPED 状態に達するのを待ちません

--timeout duration

    TERMINATED または SKIPPED 状態に達するまでの最大時間 (既定は 20m0 秒)

グローバル フラグ

Databricks ジョブを作成する

新しいジョブを作成します。

databricks jobs create [flags]

Arguments

None

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

Databricksのジョブを削除

ジョブを削除します。

databricks jobs delete JOB_ID [flags]

Arguments

JOB_ID

    削除するジョブの正規識別子。 このフィールドは必須です。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

databricks ジョブの delete-run

非アクティブな実行を削除します。 実行がアクティブである場合は、エラーが返されます。

databricks jobs delete-run RUN_ID [flags]

Arguments

RUN_ID

    削除する実行の ID

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

databricks ジョブのエクスポートと実行

ジョブ実行タスクをエクスポートして取得します。

databricks jobs export-run RUN_ID [flags]

Arguments

RUN_ID

    実行の正規識別子。 このフィールドは必須です。

オプション

--views-to-export ViewsToExport

    エクスポートするビューはどれですか。 サポートされる値: ALLCODEDASHBOARDS

グローバル フラグ

databricks ジョブを取得する

1 つのジョブの詳細を取得します。

結果の大きな配列は、要素が 100 を超えるとページ分割されます。 1 つのジョブに対する要求では、そのジョブのすべてのプロパティと、配列プロパティの最初の 100 個の要素 (タスク、job_clusters、環境、パラメーター) が返されます。 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 を超えるとページ分割されます。 1 回の実行の要求では、その実行のすべてのプロパティと、配列プロパティの最初の 100 個の要素 (タスク、job_clusters、job_parameters、repair_history) が返されます。 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 のジョブ get-run-output(実行結果を取得)

単一タスクの実行の出力とメタデータを取得します。 ノートブック タスクが 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 ジョブの修復実行

1 つ以上のジョブ タスクを再実行します。 タスクは、元のジョブ実行の一部として再実行されます。 現在のジョブとタスクの設定が使用され、元のジョブ実行の履歴で表示できます。

databricks jobs repair-run RUN_ID [flags]

Arguments

RUN_ID

    修復する実行のジョブ実行 ID。 実行は進行中であってはなりません。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--latest-repair-id int

    最新の修復の ID。

--no-wait

    TERMINATED または SKIPPED 状態に達するのを待ちません

--performance-target PerformanceTarget

    サーバーレス ジョブのパフォーマンス モード。 サポートされる値: [PERFORMANCE_OPTIMIZED、STANDARD]

--rerun-all-failed-tasks

    true の場合は、失敗したすべてのタスクを修復します。

--rerun-dependent-tasks

    true の場合は、以前に成功した場合でも、rerun_tasksのタスクに依存するすべてのタスクを修復します。

--timeout duration

    TERMINATED または SKIPPED 状態に達するまでの最大時間 (既定は 20m0 秒)

グローバル フラグ

databricks ジョブをリセット

指定されたジョブのすべての設定を上書きします。 databricks jobs update コマンドを使用して、ジョブ設定を部分的に更新します。

databricks jobs reset [flags]

Arguments

None

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

databricks ジョブを今すぐ実行する

ジョブを実行し、トリガーされた実行のrun_idを返します。

databricks jobs run-now JOB_ID [flags]

Arguments

JOB_ID

    実行するジョブの ID

オプション

--idempotency-token string

    ジョブ実行要求のべき等性を保証するためのトークン (省略可能)。

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--no-wait

    TERMINATED または SKIPPED 状態に達するのを待ちません

--performance-target PerformanceTarget

    サーバーレス ジョブのパフォーマンス モード。 サポートされる値: [PERFORMANCE_OPTIMIZED、STANDARD]

--timeout duration

    TERMINATED または SKIPPED 状態に達するまでの最大時間 (既定は 20m0 秒)

グローバル フラグ

databricks ジョブを送信

1 回限りの実行を作成して、開始します。 これにより、ジョブを作成せずにワークロードを直接送信できます。

databricks jobs submit [flags]

Note

databricks jobs submitで送信されたジョブはジョブとして保存されません。 UI には表示されず、失敗しても再試行しません。 これらは保存されないため、障害が発生した場合に Azure Databricks でサーバーレス コンピューティングを自動最適化することはできません。 ジョブが失敗した場合は、クラシック コンピューティングを使用して、ジョブのコンピューティング ニーズを指定できます。 または、 jobs createjobs run-now を使用してジョブを作成して実行します。

Arguments

None

オプション

--budget-policy-id string

    この一度限りの実行に使用する予算ポリシーのユーザー指定 ID。

--idempotency-token string

    ジョブ実行要求のべき等性を保証するために使用できるトークン (省略可能)。

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--no-wait

    TERMINATED または SKIPPED 状態に達するのを待ちません

--run-name string

    実行の名前 (省略可能)。

--timeout duration

    TERMINATED または SKIPPED 状態に達するまでの最大時間 (既定は 20m0 秒)

--timeout-seconds int

    各ジョブの実行に任意で適用できるタイムアウト。

グローバル フラグ

databricks ジョブ アップデート

既存のジョブの特定の設定を追加、更新、または削除します。 resetを使用して、すべてのジョブ設定を上書きします。

databricks jobs update JOB_ID [flags]

Arguments

JOB_ID

    更新するジョブの正規識別子。 このフィールドは必須です。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

databricks ジョブの get-permission-levels

ジョブのアクセス許可レベルを取得します。

databricks jobs get-permission-levels JOB_ID [flags]

Arguments

JOB_ID

    アクセス許可を取得または管理するジョブ。

オプション

グローバル フラグ

databricks ジョブのアクセス権取得

ジョブのアクセス許可を取得します。 ジョブは、ルート オブジェクトからアクセス許可を継承できます。

databricks jobs get-permissions JOB_ID [flags]

Arguments

JOB_ID

    アクセス許可を取得または管理するジョブ。

オプション

グローバル フラグ

databricks ジョブの権限を設定する

ジョブのアクセス許可を設定します。

オブジェクトに対する権限を設定し、既存の権限が存在する場合は置き換えます。 指定されていない場合は、すべての直接アクセス許可を削除します。 オブジェクトは、ルート オブジェクトからアクセス許可を継承できます。

databricks jobs set-permissions JOB_ID [flags]

Arguments

JOB_ID

    アクセス許可を取得または管理するジョブ。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

databricks ジョブの権限を更新する

ジョブの権限を更新します。 ジョブは、ルート オブジェクトからアクセス許可を継承できます。

databricks jobs update-permissions JOB_ID [flags]

Arguments

JOB_ID

    アクセス許可を取得または管理するジョブ。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

グローバル フラグ

--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 形式

    進行状況ログを表示する形式: defaultappendinplace、または json

-t, --target 文字列

    該当する場合は、使用するバンドル ターゲット