az batch task

Batch タスクを管理します。

コマンド

名前	説明	型	Status
az batch task create	Batch タスクを作成します。	コア	GA
az batch task delete	指定したジョブからタスクを削除します。	コア	GA
az batch task file	Batch タスク ファイルを管理します。	コア	GA
az batch task file delete	タスクが実行されたコンピューティング ノードから、指定したタスク ファイルを削除します。	コア	GA
az batch task file download	Batch タスク ファイルの内容をダウンロードします。	コア	GA
az batch task file list	コンピューティング ノード上のタスクのディレクトリ内のファイルを一覧表示します。	コア	GA
az batch task file show	指定したタスク ファイルのプロパティを取得します。	コア	GA
az batch task list	指定したジョブに関連付けられているすべてのタスクを一覧表示します。	コア	GA
az batch task reactivate	タスクを再アクティブ化し、再試行回数が不足している場合でも再度実行できるようにします。	コア	GA
az batch task reset	Batch タスクのプロパティをリセットします。	コア	GA
az batch task show	指定したタスクに関する情報を取得します。	コア	GA
az batch task stop	指定したタスクを終了します。	コア	GA
az batch task subtask	Batch タスクのサブタスク情報を管理します。	コア	GA
az batch task subtask list	指定したマルチインスタンス タスクに関連付けられているすべてのサブタスクを一覧表示します。	コア	GA

az batch task create

Batch タスクを作成します。

az batch task create --job-id
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--affinity-id]
                     [--application-package-references]
                     [--command-line]
                     [--environment-settings]
                     [--json-file]
                     [--max-task-retry-count]
                     [--max-wall-clock-time]
                     [--resource-files]
                     [--retention-time]
                     [--task-id]

必須のパラメーター

--job-id

タスクを含むジョブの ID です。

省略可能のパラメーター

--account-endpoint

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

--account-key

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

--account-name

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

--affinity-id

必須。 Node の affinityId を渡して、このタスクがそのコンピューティング ノードで実行する必要があることを示すことができます。 これは単なるソフト アフィニティであることに注意してください。 タスクがスケジュールされている時点でターゲットのコンピューティング ノードがビジー状態または使用できない場合、タスクは別の場所でスケジュールされます。

--application-package-references

インストールするアプリケーション パッケージを指定する ID のスペース区切りの一覧。 'id[#version]' 形式の省略可能なバージョンを持つスペース区切りのアプリケーション ID。

--command-line

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

--environment-settings

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

--json-file

JSON で作成するタスクを含むファイル (REST API 要求本文に一致するように書式設定)。 複数のタスクを送信するときに、タスクの配列または TaskAddCollectionParamater を受け入れます。 このパラメーターを指定すると、他のすべてのパラメーターは無視されます。

--max-task-retry-count

タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。 この値は、0 以外の終了コードが原因で Task 実行可能ファイルの再試行回数を特に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスは最初の試行後にタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、これは開始タスクまたはタスクには推奨されません。 既定値は 0 (再試行なし) です。

--max-wall-clock-time

この値を指定しない場合、タスクの実行時間に制限はありません。

--resource-files

コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 ファイル名 =httpurl 形式のスペース区切りのリソース参照。httpurl はパブリック アクセスを持つ任意の HTTP URL、または読み取りアクセス権を持つ SAS URL です。

--retention-time

既定値は 7 日間です。つまり、コンピューティング ノードが削除されるか、ジョブが削除されない限り、タスク ディレクトリは 7 日間保持されます。

--task-id

タスクの ID です。

グローバル パラメーター

--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 task delete

指定したジョブからタスクを削除します。

タスクが削除されると、実行されたコンピューティング ノード上のディレクトリ内のすべてのファイルも (保持時間に関係なく) 削除されます。 複数インスタンスのタスクの場合、タスクの削除操作はプライマリ タスクに同期的に適用されます。サブタスクとそのファイルは、バックグラウンドで非同期的に削除されます。

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

必須のパラメーター

--job-id

タスクを削除するジョブの ID。

--task-id

削除する Task の 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 task list

指定したジョブに関連付けられているすべてのタスクを一覧表示します。

複数インスタンスのタスクの場合、affinityId、executionInfo、nodeInfo などの情報は、プライマリ タスクを参照します。 サブタスクの一覧 API を使用して、サブタスクに関する情報を取得します。

az batch task list --job-id
                   [--account-endpoint]
                   [--account-key]
                   [--account-name]
                   [--expand]
                   [--filter]
                   [--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 句。

--filter

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

--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 task reactivate

タスクを再アクティブ化し、再試行回数が不足している場合でも再度実行できるようにします。

再アクティブ化すると、タスクは最大再試行回数まで再試行できるようになります。 タスクの状態がアクティブに変更されます。 タスクが完了状態ではなくなったので、以前の終了コードまたはエラー情報は、再アクティブ化後に使用できなくなります。 タスクが再アクティブ化されるたびに、再試行回数は 0 にリセットされます。 完了していないタスクまたは以前に正常に完了したタスク (終了コード 0) の場合、再アクティブ化は失敗します。 さらに、ジョブが完了した (または終了または削除中) 場合は失敗します。

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

必須のパラメーター

--job-id

タスクを含むジョブの ID。

--task-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

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

グローバル パラメーター

--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 task reset

Batch タスクのプロパティをリセットします。

az batch task reset --job-id
                    --task-id
                    [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--if-match]
                    [--if-modified-since]
                    [--if-none-match]
                    [--if-unmodified-since]
                    [--json-file]
                    [--max-task-retry-count]
                    [--max-wall-clock-time]
                    [--retention-time]

必須のパラメーター

--job-id

タスクを含むジョブの ID。

--task-id

更新する Task の 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

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

--json-file

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

--max-task-retry-count

タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。 この値は、0 以外の終了コードが原因で Task 実行可能ファイルの再試行回数を特に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスは最初の試行後にタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、これは開始タスクまたはタスクには推奨されません。 既定値は 0 (再試行なし) です。

--max-wall-clock-time

この値を指定しない場合、タスクの実行時間に制限はありません。 想定される形式は ISO-8601 期間です。

--retention-time

既定値は 7 日間です。つまり、コンピューティング ノードが削除されるか、ジョブが削除されない限り、タスク ディレクトリは 7 日間保持されます。 想定される形式は ISO-8601 期間です。

グローバル パラメーター

--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 task show

指定したタスクに関する情報を取得します。

複数インスタンスのタスクの場合、affinityId、executionInfo、nodeInfo などの情報は、プライマリ タスクを参照します。 サブタスクの一覧 API を使用して、サブタスクに関する情報を取得します。

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

必須のパラメーター

--job-id

タスクを含むジョブの ID。

--task-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

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

--if-modified-since

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

--if-none-match

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

--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 task stop

指定したタスクを終了します。

タスクが終了すると、完了状態に移動します。 複数インスタンスのタスクの場合、終了タスク操作はプライマリ タスクに同期的に適用されます。その後、サブタスクはバックグラウンドで非同期的に終了します。

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

必須のパラメーター

--job-id

タスクを含むジョブの ID。

--task-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

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

グローバル パラメーター

--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 を使います。