次の方法で共有

az batch job

Batch ジョブを管理します。

コマンド

名前 説明 型 状態
az batch job create

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

 Core GA
az batch job delete

Batch アカウントからジョブを削除します。

 Core GA
az batch job disable

Batch ジョブを無効にします。

 Core GA
az batch job enable

Batch ジョブを有効にします。

 Core GA
az batch job list

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

 Core GA
az batch job prep-release-status

Batch ジョブの準備タスクとリリース タスクの状態を表示します。

 Core GA
az batch job prep-release-status list

ジョブが実行されているコンピューティング ノード全体で、指定されたジョブのジョブ準備タスクとジョブ解放タスクの実行状態を一覧表示します。

 Core GA
az batch job reset

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

 Core GA
az batch job set

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

 Core GA
az batch job show

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

 Core GA
az batch job stop

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

 Core GA
az batch job task-counts

Batch ジョブ内のタスクとスロットの数とその状態を表示します。

 Core GA
az batch job task-counts show

指定したジョブのタスク数を取得します。

 Core GA

az batch job create

編集

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

az batch job create [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--allow-task-preemption]
                    [--id]
                    [--job-manager-task-application-package-references]
                    [--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]
                    [--on-all-tasks-complete]
                    [--pool-id]
                    [--priority]
                    [--required-slots]
                    [--uses-task-dependencies]

例

既存のプールに関連付けられている新しいジョブを作成します。

az batch job create --id job1 --pool-id pool1

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-key

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-name

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

プロパティ 値
Parameter group: Batch Account Arguments
--allow-task-preemption

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

プロパティ 値
Parameter group: Job Arguments
--id

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

プロパティ 値
Parameter group: Job Arguments
--job-manager-task-application-package-references

コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにデプロイするアプリケーション パッケージの一覧。アプリケーション パッケージは、タスク作業ディレクトリではなく、共有ディレクトリにダウンロードおよびデプロイされます。 そのため、参照先のアプリケーション パッケージが既にコンピューティング ノード上にあり、最新の状態である場合、再ダウンロードされません。コンピューティング ノード上の既存のコピーが使用されます。 参照先のアプリケーション パッケージをインストールできない場合 (たとえば、パッケージが削除されたか、ダウンロードに失敗したため)、タスクは失敗します。 'id[#version]' 形式の省略可能なバージョンを持つスペース区切りのアプリケーション ID。

プロパティ 値
Parameter group: Job: Job Manager Task Arguments
--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) を使用する必要があります。 Required.

プロパティ 値
Parameter group: Job: Job Manager Task Arguments
--job-manager-task-environment-settings

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

プロパティ 値
Parameter group: Job: Job Manager Task Arguments
--job-manager-task-id

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

プロパティ 値
Parameter group: Job: Job Manager Task Arguments
--job-manager-task-resource-files

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

プロパティ 値
Parameter group: Job: Job Manager Task Arguments
--job-max-task-retry-count

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

プロパティ 値
Parameter group: Job: Constraints Arguments
--job-max-wall-clock-time

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

プロパティ 値
Parameter group: Job: Constraints Arguments
--json-file

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

--max-parallel-tasks

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

プロパティ 値
Parameter group: Job Arguments
--metadata

ジョブにメタデータとして関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。 'key=value' 形式のスペース区切り値。

プロパティ 値
Parameter group: Job Arguments
--on-all-tasks-complete

ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。 ジョブにタスクが含まれている場合、すべてのタスクは完了と見なされることに注意してください。 そのため、このオプションは、ジョブ マネージャー タスクで最もよく使用されます。ジョブ マネージャーなしでジョブの自動終了を使用する場合は、最初に onAllTasksComplete を noaction に設定し、タスクの追加が完了したらジョブを終了するように onAllTasksComplete に設定するように Job プロパティを更新する必要があります。 既定値は noaction です。 既知の値は、"noaction" と "terminatejob" です。

プロパティ 値
Parameter group: Job Arguments
--pool-id

既存のプールの ID。 ジョブのすべてのタスクは、指定されたプールで実行されます。 このプロパティによって参照されるプールが存在することを確認する必要があります。 Batch サービスがジョブをスケジュールしようとしたときにプールが存在しない場合、その ID を持つプールを作成するまで、ジョブのタスクは実行されません。Batch サービスはジョブ要求を拒否しないことに注意してください。プールが存在するまでタスクは実行されません。 プール ID または自動プールの仕様のいずれかを指定する必要がありますが、両方を指定する必要はありません。

プロパティ 値
Parameter group: Job: Pool Info Arguments
--priority

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

プロパティ 値
Parameter group: Job Arguments
--required-slots

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

プロパティ 値
Parameter group: Job: Job Manager Task Arguments
--uses-task-dependencies

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

プロパティ 値
Parameter group: Job Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az batch job delete

編集

Batch アカウントからジョブを削除します。

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

例

確認を求めずにジョブ ID を使用してジョブを削除します。

az batch job delete --job-id job1 --yes

必須のパラメーター

--job-id

削除するジョブの ID。 Required.

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-key

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-name

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

プロパティ 値
Parameter group: Batch Account Arguments
--if-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-modified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-none-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-unmodified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--yes -y

確認を求めないでください。

プロパティ 値
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az batch job disable

編集

Batch ジョブを無効にします。

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]
                     [--json-file]

例

ジョブを無効にし、実行中のタスクを再度キューに入れ直します。

az batch job disable --job-id job1 --disable-tasks requeue

必須のパラメーター

--job-id

無効にするジョブの ID。 Required.

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-key

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-name

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

プロパティ 値
Parameter group: Batch Account Arguments
--disable-tasks

ジョブに関連付けられているアクティブなタスクの操作。 Required. 既知の値は、"requeue"、"terminate"、および "wait" です。

プロパティ 値
Parameter group: Content Arguments
--if-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-modified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-none-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-unmodified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--json-file

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

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az batch job enable

編集

Batch ジョブを有効にします。

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

例

ジョブを有効にします。

az batch job enable --job-id job1

必須のパラメーター

--job-id

有効にするジョブの ID。 Required.

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-key

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-name

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

プロパティ 値
Parameter group: Batch Account Arguments
--if-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-modified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-none-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-unmodified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az batch job list

編集

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

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

例

Batch アカウント内のすべてのジョブを一覧表示する

az batch job list

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

az batch job list --job-schedule-id jobschedule1

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-key

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-name

Batch アカウント名。 必要な場合のみ、環境変数によって設定されます:AZURE_BATCH_ACCOUNT。

プロパティ 値
Parameter group: Batch Account Arguments
--expand

OData $expand 句。

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--filter

OData $filter 句。 このフィルターの構築の詳細については、https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batchを参照してください。

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--job-schedule-id

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

--select

OData $select 句。

プロパティ 値
Parameter group: Pre-condition and Query Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

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]
                   [--pool-id]
                   [--priority]

例

優先度を除くすべてのジョブ プロパティをリセットします。

az batch job reset --job-id job1 --priority 100

必須のパラメーター

--job-id

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-key

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-name

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

プロパティ 値
Parameter group: Batch Account Arguments
--allow-task-preemption

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

プロパティ 値
Parameter group: Job Arguments
--if-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-modified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-none-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-unmodified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--job-max-task-retry-count

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

プロパティ 値
Parameter group: Job: Constraints Arguments
--job-max-wall-clock-time

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

プロパティ 値
Parameter group: Job: Constraints Arguments
--json-file

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

--max-parallel-tasks

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

プロパティ 値
Parameter group: Job Arguments
--metadata

ジョブにメタデータとして関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。 'key=value' 形式のスペース区切り値。

プロパティ 値
Parameter group: Job Arguments
--on-all-tasks-complete

ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。 既定値は noaction です。 既知の値は、"noaction" と "terminatejob" です。

プロパティ 値
Parameter group: Job Arguments
--pool-id

既存のプールの ID。 ジョブのすべてのタスクは、指定されたプールで実行されます。 このプロパティによって参照されるプールが存在することを確認する必要があります。 Batch サービスがジョブをスケジュールしようとしたときにプールが存在しない場合、その ID を持つプールを作成するまで、ジョブのタスクは実行されません。Batch サービスはジョブ要求を拒否しないことに注意してください。プールが存在するまでタスクは実行されません。 プール ID または自動プールの仕様のいずれかを指定する必要がありますが、両方を指定する必要はありません。

プロパティ 値
Parameter group: Job: Pool Info Arguments
--priority

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

プロパティ 値
Parameter group: Job Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

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]
                 [--pool-id]
                 [--priority]

例

ジョブの優先度を更新します。

az batch job set --job-id job1 --priority 100

必須のパラメーター

--job-id

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-key

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-name

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

プロパティ 値
Parameter group: Batch Account Arguments
--allow-task-preemption

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

プロパティ 値
Parameter group: Job Arguments
--if-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-modified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-none-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-unmodified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--job-max-task-retry-count

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

プロパティ 値
Parameter group: Job: Constraints Arguments
--job-max-wall-clock-time

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

プロパティ 値
Parameter group: Job: Constraints Arguments
--json-file

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

--max-parallel-tasks

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

プロパティ 値
Parameter group: Job Arguments
--metadata

ジョブにメタデータとして関連付けられている名前と値のペアの一覧。 省略すると、既存のジョブ メタデータは変更されません。 'key=value' 形式のスペース区切り値。

プロパティ 値
Parameter group: Job Arguments
--on-all-tasks-complete

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

プロパティ 値
Parameter group: Job Arguments
--pool-id

既存のプールの ID。 ジョブのすべてのタスクは、指定されたプールで実行されます。 このプロパティによって参照されるプールが存在することを確認する必要があります。 Batch サービスがジョブをスケジュールしようとしたときにプールが存在しない場合、その ID を持つプールを作成するまで、ジョブのタスクは実行されません。Batch サービスはジョブ要求を拒否しないことに注意してください。プールが存在するまでタスクは実行されません。 プール ID または自動プールの仕様のいずれかを指定する必要がありますが、両方を指定する必要はありません。

プロパティ 値
Parameter group: Job: Pool Info Arguments
--priority

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

プロパティ 値
Parameter group: Job Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az batch job show

編集

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

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]

例

ジョブに関する情報の詳細を表示します。

az batch job show --job-id job1

必須のパラメーター

--job-id

ジョブの ID。 Required.

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-key

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-name

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

プロパティ 値
Parameter group: Batch Account Arguments
--expand

OData $expand 句。

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-modified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-none-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-unmodified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--select

OData $select 句。

プロパティ 値
Parameter group: Pre-condition and Query Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

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]

例

ジョブを停止して終了理由を指定する

az batch job stop --job-id job1 --terminate-reason "Completed workflow"

必須のパラメーター

--job-id

終了するジョブの ID。 Required.

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-key

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

プロパティ 値
Parameter group: Batch Account Arguments
--account-name

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

プロパティ 値
Parameter group: Batch Account Arguments
--if-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-modified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-none-match

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--if-unmodified-since

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

プロパティ 値
Parameter group: Pre-condition and Query Arguments
--terminate-reason

Termination reason.

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

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

Output format.

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False