次の方法で共有


az batch job-schedule

Batch ジョブ スケジュールを管理します。

コマンド

名前 説明 状態
az batch job-schedule create

Batch ジョブ スケジュールをアカウントに追加します。

コア GA
az batch job-schedule delete

指定したアカウントからジョブ スケジュールを削除します。

コア GA
az batch job-schedule disable

ジョブ スケジュールを無効にします。

コア GA
az batch job-schedule enable

ジョブ スケジュールを有効にします。

コア GA
az batch job-schedule list

指定されたアカウントのすべてのジョブ スケジュールを一覧表示します。

コア GA
az batch job-schedule reset

ジョブ スケジュールのプロパティをリセットします。 更新されたジョブ仕様は、新しいジョブにのみ適用されます。

コア GA
az batch job-schedule set

ジョブ スケジュールのプロパティを更新します。

コア GA
az batch job-schedule show

指定したジョブ スケジュールに関する情報を取得します。

コア GA
az batch job-schedule stop

ジョブ スケジュールを終了します。

コア GA

az batch job-schedule create

Batch ジョブ スケジュールをアカウントに追加します。

az batch job-schedule create [--account-endpoint]
                             [--account-key]
                             [--account-name]
                             [--allow-task-preemption]
                             [--do-not-run-after]
                             [--do-not-run-until]
                             [--id]
                             [--job-manager-task-command-line]
                             [--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 {noaction, terminatejob}]
                             [--pool-id]
                             [--priority]
                             [--recurrence-interval]
                             [--required-slots]
                             [--start-window]
                             [--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 の場合フラグが存在します。

--do-not-run-after

doNotRunAfter 時刻を指定せず、定期的なジョブ スケジュールを作成する場合、ジョブ スケジュールは明示的に終了するまでメインアクティブになります。 予期される形式は ISO-8601 タイムスタンプです。

--do-not-run-until

doNotRunUntil 時間を指定しない場合、スケジュールはすぐにジョブを作成する準備が整います。 予期される形式は ISO-8601 タイムスタンプです。

--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-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 本文に一致するように書式設定)。 このパラメーターを指定すると、すべての 'クラウド ジョブ スケジュール引数' は無視されます。

--max-parallel-tasks

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

--metadata

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

--on-all-tasks-complete

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

指定可能な値: noaction, terminatejob
--pool-id

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

--priority

このスケジュールで作成されたジョブの優先順位。 優先度の値の範囲は -1000 ~ 1000 で、-1000 が最も低い優先度、1000 が最も高い優先度です。 既定値は 0 です。 この優先順位は、ジョブ スケジュールのすべてのジョブの既定値として使用されます。 ジョブの優先度は、ジョブの更新 API を使用して作成した後に更新できます。

--recurrence-interval

ジョブ スケジュールは、任意の時点で最大 1 つのアクティブなジョブを持つことができます。ジョブ スケジュールで新しいジョブを作成する場合、以前のジョブがまだ実行されている場合、Batch サービスは前のジョブが完了するまで新しいジョブを作成しません。 前のジョブが新しい recurrenceInterval の startWindow 期間内に完了しない場合、その間隔に対して新しいジョブはスケジュールされません。 定期的なジョブの場合は、通常、jobSpecification で jobManagerTask を指定する必要があります。 jobManagerTask を使用しない場合は、ジョブの作成時を監視し、タスクをジョブに追加して、次回の繰り返しに備えてジョブを終了する外部プロセスが必要になります。 既定では、スケジュールは繰り返されません。doNotRunUntil 時間の後に startWindow 内に 1 つのジョブが作成され、そのジョブが完了するとすぐにスケジュールが完了します。 最小値は 1 分です。 小さい値を指定すると、Batch サービスはエラーでスケジュールを拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 想定される形式は ISO-8601 期間です。

--required-slots

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

--start-window

startWindow 間隔内にジョブが作成されていない場合、"営業案件" は失われます。スケジュールの次の繰り返しまでジョブは作成されません。 スケジュールが定期的で、startWindow が繰り返し間隔よりも長い場合、これは無限の startWindow に相当します。これは、1 つの recurrenceInterval の "期限" であるジョブが次の繰り返し間隔に繰り返されないためです。 既定値は無限です。 最小値は 1 分です。 小さい値を指定すると、Batch サービスはエラーでスケジュールを拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 想定される形式は ISO-8601 期間です。

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

指定したアカウントからジョブ スケジュールを削除します。

ジョブ スケジュールを削除すると、そのスケジュールの下にあるすべてのジョブとタスクも削除されます。 タスクが削除されると、コンピューティング ノード上の作業ディレクトリ内のすべてのファイルも削除されます (保持期間は無視されます)。 ジョブ スケジュール統計は、ジョブ スケジュールが削除されるとアクセスできなくなりますが、アカウントの有効期間の統計にはカウントされます。

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

必須のパラメーター

--job-schedule-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-schedule disable

ジョブ スケジュールを無効にします。

ジョブ スケジュールが再度有効になるまで、新しいジョブは作成されません。

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

必須のパラメーター

--job-schedule-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 job-schedule enable

ジョブ スケジュールを有効にします。

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

必須のパラメーター

--job-schedule-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 job-schedule list

指定されたアカウントのすべてのジョブ スケジュールを一覧表示します。

az batch job-schedule list [--account-endpoint]
                           [--account-key]
                           [--account-name]
                           [--expand]
                           [--filter]
                           [--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 句。 このフィルターの構築の詳細については、次を参照してください https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules

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

ジョブ スケジュールのプロパティをリセットします。 更新されたジョブ仕様は、新しいジョブにのみ適用されます。

az batch job-schedule reset --job-schedule-id
                            [--account-endpoint]
                            [--account-key]
                            [--account-name]
                            [--allow-task-preemption]
                            [--do-not-run-after]
                            [--do-not-run-until]
                            [--if-match]
                            [--if-modified-since]
                            [--if-none-match]
                            [--if-unmodified-since]
                            [--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-metadata]
                            [--json-file]
                            [--max-parallel-tasks]
                            [--metadata]
                            [--on-all-tasks-complete {noaction, terminatejob}]
                            [--pool-id]
                            [--priority]
                            [--recurrence-interval]
                            [--required-slots]
                            [--start-window]
                            [--uses-task-dependencies]

必須のパラメーター

--job-schedule-id

更新するジョブ スケジュールの ID。

省略可能のパラメーター

--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 の場合フラグが存在します。

--do-not-run-after

doNotRunAfter 時刻を指定せず、定期的なジョブ スケジュールを作成する場合、ジョブ スケジュールは明示的に終了するまでメインアクティブになります。 予期される形式は ISO-8601 タイムスタンプです。

--do-not-run-until

doNotRunUntil 時間を指定しない場合、スケジュールはすぐにジョブを作成する準備が整います。 予期される形式は ISO-8601 タイムスタンプです。

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--job-manager-task-application-package-references

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

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

--json-file

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

--max-parallel-tasks

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

--metadata

この要素を指定しない場合は、空のリストの既定値を受け取ります。実際には、既存のメタデータはすべて削除されます。 'key=value' 形式のスペース区切り値。

--on-all-tasks-complete

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

指定可能な値: noaction, terminatejob
--pool-id

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

--priority

このスケジュールで作成されたジョブの優先順位。 優先度の値の範囲は -1000 ~ 1000 で、-1000 が最も低い優先度、1000 が最も高い優先度です。 既定値は 0 です。 この優先順位は、ジョブ スケジュールのすべてのジョブの既定値として使用されます。 ジョブの優先度は、ジョブの更新 API を使用して作成した後に更新できます。

--recurrence-interval

ジョブ スケジュールは、任意の時点で最大 1 つのアクティブなジョブを持つことができます。ジョブ スケジュールで新しいジョブを作成する場合、以前のジョブがまだ実行されている場合、Batch サービスは前のジョブが完了するまで新しいジョブを作成しません。 前のジョブが新しい recurrenceInterval の startWindow 期間内に完了しない場合、その間隔に対して新しいジョブはスケジュールされません。 定期的なジョブの場合は、通常、jobSpecification で jobManagerTask を指定する必要があります。 jobManagerTask を使用しない場合は、ジョブの作成時を監視し、タスクをジョブに追加して、次回の繰り返しに備えてジョブを終了する外部プロセスが必要になります。 既定では、スケジュールは繰り返されません。doNotRunUntil 時間の後に startWindow 内に 1 つのジョブが作成され、そのジョブが完了するとすぐにスケジュールが完了します。 最小値は 1 分です。 小さい値を指定すると、Batch サービスはエラーでスケジュールを拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 想定される形式は ISO-8601 期間です。

--required-slots

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

--start-window

startWindow 間隔内にジョブが作成されていない場合、"営業案件" は失われます。スケジュールの次の繰り返しまでジョブは作成されません。 スケジュールが定期的で、startWindow が繰り返し間隔よりも長い場合、これは無限の startWindow に相当します。これは、1 つの recurrenceInterval の "期限" であるジョブが次の繰り返し間隔に繰り返されないためです。 既定値は無限です。 最小値は 1 分です。 小さい値を指定すると、Batch サービスはエラーでスケジュールを拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 想定される形式は ISO-8601 期間です。

--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-schedule set

ジョブ スケジュールのプロパティを更新します。

スケジュールとジョブの指定は個別に更新できますが、これらのエンティティのいずれかに変更を加えると、そのエンティティ内のすべてのプロパティがリセットされます。

az batch job-schedule set --job-schedule-id
                          [--account-endpoint]
                          [--account-key]
                          [--account-name]
                          [--allow-task-preemption]
                          [--do-not-run-after]
                          [--do-not-run-until]
                          [--if-match]
                          [--if-modified-since]
                          [--if-none-match]
                          [--if-unmodified-since]
                          [--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-metadata]
                          [--json-file]
                          [--max-parallel-tasks]
                          [--metadata]
                          [--on-all-tasks-complete {noaction, terminatejob}]
                          [--pool-id]
                          [--priority]
                          [--recurrence-interval]
                          [--required-slots]
                          [--start-window]
                          [--uses-task-dependencies]

必須のパラメーター

--job-schedule-id

更新するジョブ スケジュールの ID。

省略可能のパラメーター

--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' または 'false' を指定します。

--do-not-run-after

doNotRunAfter 時刻を指定せず、定期的なジョブ スケジュールを作成する場合、ジョブ スケジュールは明示的に終了するまでメインアクティブになります。 予期される形式は ISO-8601 タイムスタンプです。

--do-not-run-until

doNotRunUntil 時間を指定しない場合、スケジュールはすぐにジョブを作成する準備が整います。 予期される形式は ISO-8601 タイムスタンプです。

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--job-manager-task-application-package-references

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

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

--json-file

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

--max-parallel-tasks

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

--metadata

この要素を指定しない場合、既存のメタデータは変更されません。 'key=value' 形式のスペース区切り値。

--on-all-tasks-complete

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

指定可能な値: noaction, terminatejob
--pool-id

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

--priority

このスケジュールで作成されたジョブの優先順位。 優先度の値の範囲は -1000 ~ 1000 で、-1000 が最も低い優先度、1000 が最も高い優先度です。 既定値は 0 です。 この優先順位は、ジョブ スケジュールのすべてのジョブの既定値として使用されます。 ジョブの優先度は、ジョブの更新 API を使用して作成した後に更新できます。

--recurrence-interval

ジョブ スケジュールは、任意の時点で最大 1 つのアクティブなジョブを持つことができます。ジョブ スケジュールで新しいジョブを作成する場合、以前のジョブがまだ実行されている場合、Batch サービスは前のジョブが完了するまで新しいジョブを作成しません。 前のジョブが新しい recurrenceInterval の startWindow 期間内に完了しない場合、その間隔に対して新しいジョブはスケジュールされません。 定期的なジョブの場合は、通常、jobSpecification で jobManagerTask を指定する必要があります。 jobManagerTask を使用しない場合は、ジョブの作成時を監視し、タスクをジョブに追加して、次回の繰り返しに備えてジョブを終了する外部プロセスが必要になります。 既定では、スケジュールは繰り返されません。doNotRunUntil 時間の後に startWindow 内に 1 つのジョブが作成され、そのジョブが完了するとすぐにスケジュールが完了します。 最小値は 1 分です。 小さい値を指定すると、Batch サービスはエラーでスケジュールを拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 想定される形式は ISO-8601 期間です。

--required-slots

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

--start-window

startWindow 間隔内にジョブが作成されていない場合、"営業案件" は失われます。スケジュールの次の繰り返しまでジョブは作成されません。 スケジュールが定期的で、startWindow が繰り返し間隔よりも長い場合、これは無限の startWindow に相当します。これは、1 つの recurrenceInterval の "期限" であるジョブが次の繰り返し間隔に繰り返されないためです。 既定値は無限です。 最小値は 1 分です。 小さい値を指定すると、Batch サービスはエラーでスケジュールを拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 想定される形式は ISO-8601 期間です。

--uses-task-dependencies

ジョブ内のタスクが相互に依存関係を定義できるかどうかを示します。 既定値は false です。 プロパティを更新するには、'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-schedule show

指定したジョブ スケジュールに関する情報を取得します。

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

必須のパラメーター

--job-schedule-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 job-schedule stop

ジョブ スケジュールを終了します。

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

必須のパラメーター

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