az batch job

リファレンス

Note

このコマンドグループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。各拡張機能をインストールして、拡張機能を活用します。拡張機能の詳細をご覧ください。

Batch ジョブを管理します。

コマンド

名前	説明	型	状態
az batch job create	Batch アカウントにジョブを追加します。	コア	GA
az batch job create (azure-batch-cli-extensions 拡張機能)	ジョブと関連付けられているタスクを Batch アカウントに追加します。	拡張	GA
az batch job delete	ジョブを削除します。	コア	GA
az batch job disable	指定したジョブを無効にして、新しいタスクが実行されないようにします。	コア	GA
az batch job enable	指定したジョブを有効にして、新しいタスクを実行できるようにします。	コア	GA
az batch job list	Batch アカウント内のすべてのジョブまたはジョブスケジュールを一覧表示します。	コア	GA
az batch job prep-release-status	Batch ジョブの準備タスクとリリースタスクの状態を表示します。	コア	GA
az batch job prep-release-status list	ジョブが実行されているコンピューティングノード全体で、指定されたジョブのジョブ準備タスクとジョブ解放タスクの実行状態を一覧表示します。	コア	GA
az batch job reset	Batch ジョブのプロパティを更新します。更新できる未指定のプロパティは、既定値にリセットされます。	コア	GA
az batch job set	Batch ジョブのプロパティを更新します。サブグループ内のプロパティを更新すると、そのグループの未指定のプロパティがリセットされます。	コア	GA
az batch job show	指定したジョブに関する情報を取得します。	コア	GA
az batch job stop	実行中の Batch ジョブを停止します。	コア	GA
az batch job task-counts	Batch ジョブ内のタスクとスロットの数とその状態を表示します。	コア	GA
az batch job task-counts show	指定したジョブのタスク数を取得します。	コア	GA

az batch job create

編集

Batch アカウントにジョブを追加します。

az batch job create [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--allow-task-preemption]
                    [--id]
                    [--job-manager-task-command-line]
                    [--job-manager-task-environment-settings]
                    [--job-manager-task-id]
                    [--job-manager-task-resource-files]
                    [--job-max-task-retry-count]
                    [--job-max-wall-clock-time]
                    [--json-file]
                    [--max-parallel-tasks]
                    [--metadata]
                    [--pool-id]
                    [--priority]
                    [--required-slots]
                    [--uses-task-dependencies]

省略可能のパラメーター

--account-endpoint

Batch サービスエンドポイント。または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウントキー。または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウント名。または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--allow-task-preemption

このジョブのタスクを他の優先度の高いジョブに割り込むことができるかどうか。値が True に設定されている場合、システムに送信された他の優先度の高いジョブが優先され、このジョブからタスクを再キューできます。ジョブの allowTaskPreemption は、更新ジョブ API を使用して作成された後で更新できます。 True の場合フラグが存在します。

--id

必須。 ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なる 2 つの ID がない可能性があります)。

--job-manager-task-command-line

必須。コマンドラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。このような機能を利用する場合は、コマンドラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。コマンドラインがファイルパスを参照している場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で提供される環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。

--job-manager-task-environment-settings

'key=value' 形式のスペース区切り値。

--job-manager-task-id

必須。 ID には、ハイフンやアンダースコアを含む英数字を任意に組み合わせて使用でき、64 文字を超えることはできません。

--job-manager-task-resource-files

この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。リソースファイルの一覧には最大サイズがあります。最大サイズを超えると、要求は失敗し、応答エラーコードは RequestEntityTooLarge になります。この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。これは、.zip ファイル、アプリケーションパッケージ、または Docker コンテナーを使用して実現できます。 filename=httpurl 形式のスペース区切りのリソース参照。

--job-max-task-retry-count

各タスクを再試行できる最大回数。終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。この値によって再試行の回数が限定されますのでご注意ください。 Batch サービスは各タスクを 1 回試し、この制限まで再試行できます。たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回 (1 回の最初の試行と 3 回の再試行) まで試行します。最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行します。既定値は 0 (再試行なし) です。

--job-max-wall-clock-time

ジョブが制限時間内に完了しない場合、Batch サービスはジョブを終了し、実行中のすべてのタスクを終了します。この場合、終了の理由は MaxWallClockTimeExpiry になります。このプロパティを指定しない場合、ジョブの実行時間に制限はありません。想定される形式は ISO-8601 期間です。

--json-file

JSON のジョブ仕様を含むファイル (それぞれの REST API 本文に一致するように書式設定)。このパラメーターを指定すると、すべての 'Job 引数' は無視されます。

--max-parallel-tasks

ジョブに対して並列に実行できるタスクの最大数。 maxParallelTasks の値は、-1 または 0 より大きい値 (指定されている場合) である必要があります。指定しない場合、既定値は -1 です。つまり、一度に実行できるタスクの数に制限はありません。ジョブの maxParallelTasks は、更新ジョブ API を使用して作成された後で更新できます。既定値: -1.

--metadata

Batch サービスは、メタデータに意味を割り当てません。これは、ユーザーコードの使用のみを目的とします。 'key=value' 形式のスペース区切り値。

--pool-id

既存のプールの ID。ジョブのすべてのタスクは、指定されたプールで実行されます。

--priority

ジョブの優先順位。優先度の値の範囲は -1000 ~ 1000 で、-1000 が最も低い優先度、1000 が最も高い優先度です。既定値は 0 です。

--required-slots

タスクの実行に必要なスケジュールスロットの数。既定値は 1 です。タスクは、ノードに十分な空きスケジュールスロットがある場合にのみ、コンピューティングノードで実行するようにスケジュールできます。複数インスタンスのタスクの場合、このプロパティはサポートされていないため、指定しないでください。

--uses-task-dependencies

ジョブ内のタスクが相互に依存関係を定義できるかどうかを示します。既定値は false です。 True の場合フラグが存在します。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az batch job create (azure-batch-cli-extensions 拡張機能)

ジョブと関連付けられているタスクを Batch アカウントに追加します。

az batch job create [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--allow-task-preemption]
                    [--id]
                    [--job-manager-task-command-line]
                    [--job-manager-task-environment-settings]
                    [--job-manager-task-id]
                    [--job-manager-task-resource-files]
                    [--job-max-task-retry-count]
                    [--job-max-wall-clock-time]
                    [--json-file]
                    [--max-parallel-tasks]
                    [--metadata]
                    [--parameters]
                    [--pool-id]
                    [--priority]
                    [--required-slots]
                    [--resource-group]
                    [--template]
                    [--uses-task-dependencies]

省略可能のパラメーター

--account-endpoint

Batch サービスエンドポイント。または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウントキー。または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウントの名前。または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--allow-task-preemption

--id

--job-manager-task-command-line

ジョブマネージャータスクのコマンドライン。コマンドラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。このような機能を利用する場合は、コマンドラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。

--job-manager-task-environment-settings

ジョブマネージャータスクの環境変数設定の一覧。 'key=value' 形式のスペース区切り値。

--job-manager-task-id

ジョブ内のジョブマネージャータスクを一意に識別する文字列。 ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。

--job-manager-task-resource-files

コマンドラインを実行する前に Batch サービスがコンピューティングノードにダウンロードするファイルの一覧。この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。スペースで区切られたリソース参照 (filename=httpurl 形式)。

--job-max-task-retry-count

各タスクを再試行できる最大回数。 Batch サービスは、終了コードが 0 以外の場合にタスクを再試行します。この値によって再試行の回数が限定されますのでご注意ください。 Batch サービスは各タスクを 1 回試行し、この制限まで再試行できます。たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (初回試行 1 回と再試行 3 回)。最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。最大再試行回数が -1 の場合、Batch サービスはタスクを無制限に再試行します。既定値は 0 (再試行なし) です。

--job-max-wall-clock-time

ジョブが実行される可能性がある最大経過時間。ジョブが作成された時刻から測定されます。ジョブが制限時間内に完了しない場合、Batch サービスはジョブを終了し、実行中のすべてのタスクを終了します。この場合、終了の理由は MaxWallClockTimeExpiry になります。このプロパティを指定しない場合、ジョブの実行時間に制限はありません。想定される形式は ISO-8601 期間です。

--json-file

--max-parallel-tasks

--metadata

Batch サービスは、メタデータに意味を割り当てません。これは、ユーザーコードの使用のみを目的とします。

--parameters

Batch ジョブ JSON テンプレートファイルのパラメーター値。 --template でのみ使用できます。

--pool-id

既存のプールの ID。ジョブのすべてのタスクは、指定されたプールで実行されます。

--priority

ジョブの優先順位。優先度の値の範囲は -1000 ~ 1000 で、-1000 が最も低い優先度、1000 が最も高い優先度です。既定値は 0 です。

--required-slots

--resource-group

Batch アカウントのリソースグループ。

--template

Batch ジョブ JSON テンプレートファイル。このパラメーターを指定すると、他のすべてのパラメーターは無視されます。

--uses-task-dependencies

このジョブが依存関係のあるタスクを使用するかどうかを決定するフラグ。 True の場合フラグが存在します。

規定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az batch job delete

編集

ジョブを削除します。

ジョブを削除すると、そのジョブの一部であるすべてのタスクとすべてのジョブ統計も削除されます。これにより、タスクデータの保持期間もオーバーライドされます。つまり、コンピューティングノードにまだ保持されているタスクがジョブに含まれている場合、Batch サービスはそれらのタスクの作業ディレクトリとそのすべての内容を削除します。ジョブの削除要求を受信すると、Batch サービスはジョブを削除状態に設定します。状態を削除中のジョブに対するすべての更新操作は、状態コード 409 (競合) で失敗し、ジョブが削除されていることを示す追加情報が表示されます。

az batch job delete --job-id
                    [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--if-match]
                    [--if-modified-since]
                    [--if-none-match]
                    [--if-unmodified-since]
                    [--yes]

必須のパラメーター

--job-id

削除するジョブの ID。

省略可能のパラメーター

--account-endpoint

Batch サービスエンドポイント。または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウントキー。または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウント名。または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--if-match

クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と正確に一致する場合にのみ実行されます。

--if-modified-since

クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。この操作は、サービス上のリソースが指定された時刻以降に変更された場合にのみ実行されます。

--if-none-match

クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と一致しない場合にのみ実行されます。

--if-unmodified-since

クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。この操作は、指定した時刻以降にサービス上のリソースが変更されていない場合にのみ実行されます。

--yes -y

確認のダイアログを表示しません。

規定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az batch job disable

編集

指定したジョブを無効にして、新しいタスクが実行されないようにします。

Batch サービスは、ジョブをすぐに無効化状態に移動します。次に、Batch は disableTasks パラメーターを使用して、ジョブの現在実行中のタスクの処理を決定します。無効化操作が完了し、disableTasks オプションに従ってすべてのタスクが処理されるまで、ジョブは無効化状態メイン。その後、ジョブは無効状態に移行します。アクティブな状態に戻るまで、ジョブの下で新しいタスクは開始されません。アクティブ、無効化、または無効以外の状態のジョブを無効にしようとすると、要求は状態コード 409 で失敗します。

az batch job disable --job-id
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--disable-tasks]
                     [--if-match]
                     [--if-modified-since]
                     [--if-none-match]
                     [--if-unmodified-since]

必須のパラメーター

--job-id

無効にするジョブの ID。

省略可能のパラメーター

--account-endpoint

Batch サービスエンドポイント。または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウントキー。または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウント名。または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--disable-tasks

使用可能な値は、'requeue'、'terminate'、'wait' です。

--if-match

--if-modified-since

--if-none-match

--if-unmodified-since

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az batch job enable

編集

指定したジョブを有効にして、新しいタスクを実行できるようにします。

この API を呼び出すと、Batch サービスは無効なジョブを有効化状態に設定します。この操作が完了すると、ジョブはアクティブな状態に移行し、ジョブの下の新しいタスクのスケジュールが再開されます。 Batch サービスでは、180 日を超える間、タスクをアクティブな状態で再メインすることはできません。そのため、180 日以上前に追加されたアクティブなタスクを含むジョブを有効にした場合、それらのタスクは実行されません。

az batch job enable --job-id
                    [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--if-match]
                    [--if-modified-since]
                    [--if-none-match]
                    [--if-unmodified-since]

必須のパラメーター

--job-id

有効にするジョブの ID。

省略可能のパラメーター

--account-endpoint

Batch サービスエンドポイント。または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウントキー。または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウント名。または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--if-match

--if-modified-since

--if-none-match

--if-unmodified-since

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az batch job list

編集

Batch アカウント内のすべてのジョブまたはジョブスケジュールを一覧表示します。

az batch job list [--account-endpoint]
                  [--account-key]
                  [--account-name]
                  [--expand]
                  [--filter]
                  [--job-schedule-id]
                  [--select]

省略可能のパラメーター

--account-endpoint

Batch サービスエンドポイント。または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウントキー。または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウントの名前。または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--expand

OData $expand 句。

--filter

OData $filter 句。

--job-schedule-id

ジョブの一覧を取得するジョブスケジュールの ID。省略すると、アカウント内のすべてのジョブが一覧表示されます。

--select

OData $select 句。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az batch job reset

編集

Batch ジョブのプロパティを更新します。更新できる未指定のプロパティは、既定値にリセットされます。

az batch job reset --job-id
                   [--account-endpoint]
                   [--account-key]
                   [--account-name]
                   [--allow-task-preemption]
                   [--if-match]
                   [--if-modified-since]
                   [--if-none-match]
                   [--if-unmodified-since]
                   [--job-max-task-retry-count]
                   [--job-max-wall-clock-time]
                   [--json-file]
                   [--max-parallel-tasks]
                   [--metadata]
                   [--on-all-tasks-complete {noaction, terminatejob}]
                   [--pool-id]
                   [--priority]

必須のパラメーター

--job-id

更新するプロパティを持つジョブの ID。

省略可能のパラメーター

--account-endpoint

Batch サービスエンドポイント。または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウントキー。または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウント名。または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--allow-task-preemption

--if-match

--if-modified-since

--if-none-match

--if-unmodified-since

--job-max-task-retry-count

--job-max-wall-clock-time

--json-file

ジョブ更新パラメーターの仕様を JSON に含むファイル (それぞれの REST API 本文に一致するように書式設定)。このパラメーターを指定すると、すべての 'Job 引数' は無視されます。

--max-parallel-tasks

--metadata

省略すると、空のリストの既定値が使用されます。実際には、既存のメタデータはすべて削除されます。 'key=value' 形式のスペース区切り値。

--on-all-tasks-complete

ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。省略すると、完了動作は noaction に設定されます。現在の値が terminatejob の場合、ジョブの完了動作が terminatejob から noaction に変更されない可能性があるため、これはエラーです。値を terminatejob から noaction に変更することはできません。つまり、ジョブの自動終了を開始した後は、もう一度オフにすることはできません。これを行おうとすると、要求は失敗し、Batch は状態コード 400 (無効な要求) と "無効なプロパティ値" エラー応答を返します。 PUT 要求でこの要素を指定しない場合、noaction を渡すことと同じです。現在の値が terminatejob の場合、これはエラーです。

指定可能な値: noaction, terminatejob

--pool-id

既存のプールの ID。ジョブのすべてのタスクは、指定されたプールで実行されます。

--priority

ジョブの優先順位。優先度の値の範囲は -1000 ~ 1000 で、-1000 が最も低い優先度、1000 が最も高い優先度です。省略すると、既定値 0 に設定されます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az batch job set

編集

Batch ジョブのプロパティを更新します。サブグループ内のプロパティを更新すると、そのグループの未指定のプロパティがリセットされます。

az batch job set --job-id
                 [--account-endpoint]
                 [--account-key]
                 [--account-name]
                 [--allow-task-preemption]
                 [--if-match]
                 [--if-modified-since]
                 [--if-none-match]
                 [--if-unmodified-since]
                 [--job-max-task-retry-count]
                 [--job-max-wall-clock-time]
                 [--json-file]
                 [--max-parallel-tasks]
                 [--metadata]
                 [--on-all-tasks-complete {noaction, terminatejob}]
                 [--pool-id]
                 [--priority]

必須のパラメーター

--job-id

更新するプロパティを持つジョブの ID。

省略可能のパラメーター

--account-endpoint

Batch サービスエンドポイント。または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウントキー。または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウント名。または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--allow-task-preemption

--if-match

--if-modified-since

--if-none-match

--if-unmodified-since

--job-max-task-retry-count

--job-max-wall-clock-time

--json-file

JSON のジョブパッチパラメーター仕様を含むファイル (それぞれの REST API 本文に一致するように書式設定)。このパラメーターを指定すると、すべての 'Job 引数' は無視されます。

--max-parallel-tasks

--metadata

省略すると、既存のジョブメタデータは変更されません。 'key=value' 形式のスペース区切り値。

--on-all-tasks-complete

ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。省略すると、完了動作は変更されません。値を terminatejob から noaction に変更することはできません。つまり、ジョブの自動終了を開始した後は、もう一度オフにすることはできません。これを行おうとすると、要求は "無効なプロパティ値" エラー応答で失敗します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

指定可能な値: noaction, terminatejob

--pool-id

既存のプールの ID。ジョブのすべてのタスクは、指定されたプールで実行されます。

--priority

ジョブの優先順位。優先度の値の範囲は -1000 ~ 1000 で、-1000 が最も低い優先度、1000 が最も高い優先度です。省略すると、ジョブの優先度は変更されません。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az batch job show

編集

指定したジョブに関する情報を取得します。

az batch job show --job-id
                  [--account-endpoint]
                  [--account-key]
                  [--account-name]
                  [--expand]
                  [--if-match]
                  [--if-modified-since]
                  [--if-none-match]
                  [--if-unmodified-since]
                  [--select]

必須のパラメーター

--job-id

ジョブの ID。

省略可能のパラメーター

--account-endpoint

Batch サービスエンドポイント。または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウントキー。または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウント名。または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--expand

OData $expand 句。

--if-match

--if-modified-since

--if-none-match

--if-unmodified-since

--select

OData $select 句。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az batch job stop

編集

実行中の Batch ジョブを停止します。

指定したジョブを終了し、完了としてマークします。ジョブの終了要求を受信すると、Batch サービスによってジョブが終了状態に設定されます。その後、Batch サービスは、ジョブに関連付けられている実行中のタスクを終了し、必要なジョブ解放タスクを実行します。その後、ジョブは完了状態に移行します。ジョブにアクティブな状態のタスクがある場合は、アクティブな状態でメインされます。ジョブが終了すると、新しいタスクを追加できず、再メインアクティブなタスクはスケジュールされません。

az batch job stop --job-id
                  [--account-endpoint]
                  [--account-key]
                  [--account-name]
                  [--if-match]
                  [--if-modified-since]
                  [--if-none-match]
                  [--if-unmodified-since]
                  [--terminate-reason]

必須のパラメーター

--job-id

終了するジョブの ID。

省略可能のパラメーター

--account-endpoint

Batch サービスエンドポイント。または、環境変数で設定します: AZURE_BATCH_ENDPOINT。

--account-key

Batch アカウントキー。または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。

--account-name

Batch アカウント名。または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。

--if-match

--if-modified-since

--if-none-match

--if-unmodified-since

--terminate-reason

終了の理由。

ジョブの TerminateReason として表示するテキスト。既定値は "UserTerminate" です。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az batch job

コマンド

az batch job create

省略可能のパラメーター

az batch job create (azure-batch-cli-extensions 拡張機能)

省略可能のパラメーター

az batch job delete

必須のパラメーター

省略可能のパラメーター

az batch job disable

必須のパラメーター

省略可能のパラメーター

az batch job enable

必須のパラメーター

省略可能のパラメーター

az batch job list

省略可能のパラメーター

az batch job reset

必須のパラメーター

省略可能のパラメーター

az batch job set

必須のパラメーター

省略可能のパラメーター

az batch job show

必須のパラメーター

省略可能のパラメーター

az batch job stop

必須のパラメーター

省略可能のパラメーター

その他のリソース