Jobs - Create Job

要求が成功し、結果として新しいリソースが作成されました。

ヘッダー

• DataServiceId: string
• ETag: string
• Last-Modified: string
• client-request-id: string
• request-id: string

BatchError

予期しないエラー応答。

BatchAccessScope[]

トークンがアクセス権を与えるバッチリソース。 認証トークンは、限定されたバッチサービス操作へのアクセスを提供します。 現在、アクセスプロパティでサポートされているのは「job」のみで、これはタスクを含むジョブに関連するすべての操作へのアクセスを許可します。

boolean

OS イメージのロールバック機能を無効にする必要があるかどうか。

boolean

新しいバージョンの OS イメージが使用可能になったときに、OS アップグレードをスケール セット インスタンスに自動的に適用するかどうかを示します。

Windows ベースのプールに対してこれが true に設定されている場合、WindowsConfiguration.enableAutomaticUpdates を true に設定することはできません。

boolean

タスクを実行している場合は、TVM の OS アップグレードを延期します。

boolean

自動 OS アップグレード中にローリング アップグレード ポリシーを使用するかどうかを示します。 VMSS でポリシーが定義されていない場合、OS の自動アップグレードは既定のポリシーにフォールバックします。

ElevationLevel

自動ユーザーの昇格レベル。 既定値は nonAdmin です。

AutoUserScope

自動ユーザーのスコープ。 既定値は pool です。 プールが Windows を実行している場合は、タスク間のより厳密な分離が必要な場合は、Task の値を指定する必要があります。 たとえば、タスクが他のタスクに影響を与える可能性のある方法でレジストリを変更する場合などです。

string (password)

Azure ストレージ アカウント キー。 このプロパティは、sasKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。

string

Azure ストレージ アカウント名。

string

mount コマンドに渡す追加のコマンド ライン オプション。 これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。

string

Azure Blob Storage コンテナー名。

BatchNodeIdentityReference

containerNameにアクセスするために使うユーザー割り当てのアイデンティティを参照します。 このプロパティは、accountKey と sasKey の両方と相互に排他的です。正確に 1 つを指定する必要があります。

string

ファイルシステムがマウントされる計算ノード上の相対パスです。 すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。

string (password)

Azure Storage SAS トークン。 このプロパティは accountKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。

string (password)

Azure Storage アカウント キー。

string

Azure Storage アカウント名。

string (uri)

Azure Files の URL。 これは 'https://{account}.file.core.windows.net/' の形式です。

string

mount コマンドに渡す追加のコマンド ライン オプション。 これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。

string

ファイルシステムがマウントされる計算ノード上の相対パスです。 すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。

string

デプロイするアプリケーションのID。 プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。

string

デプロイするアプリケーションのバージョン。 省略すると、既定のバージョンがデプロイされます。 もしプール上でこれを省略し、このアプリケーションにデフォルトバージョンが指定されていない場合、リクエストはInvalidApplicationPackageReferencesエラーコードとHTTPステータスコード409で失敗します。 もしタスクでこれが省略され、かつそのアプリケーションにデフォルトバージョンが指定されていない場合、タスクは前処理エラーで失敗します。

string

プールが自動的に作成される際に、固有の識別子に追加されるプレフィックス。 バッチサービスは、各自動プールの作成時に一意の識別子を割り当てます。 異なる目的で作成されたプールを区別するために、この要素を指定して割り当てられたIDにプレフィックスを追加できます。 接頭辞は最大20文字まで可能です。

boolean

オートプールの有効期限が過ぎても存続させるかどうか。 もしフェイスの場合、バッチサービスはプールの寿命(poolLifetimeOption設定で決定)が終了するとそのプールを削除します。つまり、ジョブまたはジョブスケジュールが完了した時です。 もしそうであれば、バッチサービスはプールを自動的に削除しません。 このオプションで作成された自動プールを削除するのはユーザー次第です。

BatchPoolSpecification

オートプールのプール仕様。

BatchPoolLifetimeOption

作成された自動プールの最小寿命や、スケジュール上の複数のジョブがプールに割り当てられる方法についてです。

string[]

コンテナイメージ名のコレクション。 これは「docker pull」で指定される完全なイメージ参照です。 イメージは、代替レジストリで完全に限定されていない限り、デフォルトのDockerレジストリからソース化されます。

ContainerRegistryReference[]

コンテナーをプルできる追加のプライベート レジストリ。 もしプライベートレジストリからダウンロードする画像が認証情報が必要な場合は、その認証情報をここで提供しなければなりません。

ContainerType

使用するコンテナー テクノロジ。

DiffDiskPlacement

プール内のすべての VM のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 このプロパティは、要求のユーザーが、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスク領域などの場所を選択するために使用できます。 エフェメラル OS ディスク サイズの要件の詳細については、https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements の Windows VM と https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirementsの Linux VM のエフェメラル OS ディスク サイズ要件に関するページを参照してください。

string

エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。

BatchErrorMessage

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

BatchErrorDetail[]

エラーに関する追加の詳細を含むキーと値のペアのコレクション。

string

Value プロパティの意味を指定する識別子。

string

エラー応答に含まれる追加情報。

string

エラーメッセージの言語コード。

string

メッセージのテキスト。

integer (int32)

コンピュートノードのポート番号。 これはバッチプール内で一意でなければなりません。 29876 から 29877 を除き、使用可能な値は 1 から 65535 の間です。これらは予約されています。 予約された値が指定された場合、要求は HTTP 状態コード 400 で失敗します。

integer (int32)

個々のCompute NodeのバックエンドPortへのインバウンドアクセスを提供する外部ポートの範囲内で最後のポート番号です。 指定できる値の範囲は 1 ~ 65534 です。ただし、Batch サービスによって予約されているポートは 50000 ~ 55000 です。 プール内のすべてのレンジは明確でなければならず、重なってはなりません。 各レンジには少なくとも40個のポートが必要です。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。

integer (int32)

個々のコンピュートノードのバックエンドPortへのインバウンドアクセスを提供する外部ポートの範囲内で最初のポート番号です。 使用可能な値の範囲は 1 ~ 65534 です。ただし、予約されているポートは 50000 ~ 55000 です。 プール内のすべてのレンジは明確でなければならず、重なってはなりません。 各レンジには少なくとも40個のポートが必要です。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。

string

エンドポイントの名前。 名前はバッチプール内で一意でなければならず、文字、数字、下線、ピリオド、ハイフンを含むことができます。 名前は文字または数字で始まる必要があり、末尾は文字、数字、またはアンダースコアで終わる必要があり、77 文字を超えることはできません。 無効な値が指定された場合、要求は HTTP 状態コード 400 で失敗します。

NetworkSecurityGroupRule[]

エンドポイントに適用されるネットワーク セキュリティ グループ規則の一覧。 バッチプール上のすべてのエンドポイントで指定できるルールの最大数は25です。 ネットワーク セキュリティ グループの規則が指定されていない場合は、指定された backendPort への受信アクセスを許可する既定の規則が作成されます。 ネットワーク セキュリティ グループ規則の最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。

InboundEndpointProtocol

エンドポイントのプロトコル。

integer (int32)

各タスクをリトライできる最大回数。 終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。 この値は、再試行回数を特に制御します。 バッチサービスは各タスクを一度だけ試行し、その後この制限まで再試行できます。 例えば、最大リトライ回数が3回の場合、バッチはタスクを最大4回(初回1回、再試行3回)試行します。 最大再試行回数が0の場合、バッチサービスはタスクを再試行しません。 最大リトライ回数が-1の場合、バッチサービスはタスクを制限なく再試行します。 既定値は 0 (再試行なし) です。

string (duration)

ジョブが作成された時点から測定される最大経過時間。 ジョブが期限内に完了しなかった場合、バッチサービスはジョブと実行中のタスクを終了します。 この場合、終了理由はMaxWallClockTimeExpiryとなります。 このプロパティが指定されていない場合、ジョブの実行期間に制限はありません。

boolean

このジョブのタスクを他の優先度の高いジョブに割り込むことができるかどうか。 (このプロパティはデフォルトでは使用できません。詳細については、サポートにお問い合わせください)この値を True に設定すると、システムに送信された他の優先度の高いジョブが優先され、このジョブからタスクを再キューに入れることができます。 ジョブの allowTaskPreemption は、更新ジョブ API を使用して作成された後で更新できます。

EnvironmentSetting[]

一般的な環境変数設定の一覧。 これらの環境変数は、ジョブ内のすべてのタスク (ジョブ マネージャー、ジョブ準備タスク、ジョブ解放タスクを含む) に設定されます。 個々のタスクは、同じ設定名を別の値で指定することで、ここで指定した環境設定をオーバーライドできます。

BatchJobConstraints

ジョブの実行制約。

string

ジョブの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。

string

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

BatchJobManagerTask

ジョブの開始時に起動されるジョブ マネージャー タスクの詳細。 ジョブでジョブ マネージャー タスクが指定されていない場合、ユーザーはジョブにタスクを明示的に追加する必要があります。 ジョブでジョブ マネージャー タスクが指定されている場合、Batch サービスはジョブの作成時にジョブ マネージャー タスクを作成し、ジョブ内の他のタスクをスケジュールする前にジョブ マネージャー タスクのスケジュールを試みます。 ジョブ マネージャー タスクの一般的な目的は、ジョブの実行を制御または監視することです。たとえば、実行するその他のタスクの決定、作業の完了時期の決定などです (ただし、ジョブ マネージャー タスクはこれらのアクティビティに限定されません。これはシステム内の完全に本格的なタスクであり、ジョブに必要なすべてのアクションを実行します)。たとえば、ジョブ マネージャー タスクでは、パラメーターとして指定されたファイルをダウンロードし、そのファイルの内容を分析し、それらの内容に基づいて追加のタスクを送信できます。

BatchJobPreparationTask

ジョブ準備タスク。 ジョブにジョブ準備タスクがある場合、Batch サービスは、そのコンピューティング ノードでそのジョブのタスクを開始する前に、ノードでジョブ準備タスクを実行します。

BatchJobReleaseTask

ジョブ解放タスク。 ジョブ解放タスクは、ジョブのジョブ準備タスクも指定しないと指定できません。 Batch サービスは、ジョブ準備タスクを実行したノードでジョブ解放タスクを実行します。 ジョブ解放タスクの主な目的は、ジョブ準備タスクによって行われたコンピューティング ノードの変更を元に戻すことです。 アクティビティの例としては、ローカル ファイルの削除や、ジョブの準備の一環として開始されたサービスのシャットダウンなどがあります。

integer (int32)

ジョブに対して並列に実行できるタスクの最大数。 (このプロパティはデフォルトでは使用できません。詳細については、サポートにお問い合わせください)maxParallelTasks の値は、指定されている場合は -1 または 0 より大きくする必要があります。 指定しない場合、既定値は -1 です。つまり、一度に実行できるタスクの数に制限はありません。 ジョブの maxParallelTasks は、更新ジョブ API を使用して作成された後で更新できます。

BatchMetadataItem[]

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

BatchJobNetworkConfiguration

(このプロパティはデフォルトでは使用できません。詳細については、サポートにお問い合わせください)ジョブのネットワーク構成。

BatchAllTasksCompleteMode

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

BatchTaskFailureMode

ジョブ内のタスクが失敗したときに Batch サービスが実行する必要があるアクション。 failureInfo がある場合、タスクは失敗したと見なされます。 failureInfo は、再試行回数を使い果たした後にタスクが 0 以外の終了コードで完了した場合、またはリソース ファイルのダウンロード エラーが原因でタスクの開始エラーが発生した場合に設定されます。 既定値は noaction です。

BatchPoolInfo

Batch サービスがジョブのタスクを実行するプール。

integer (int32)

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

boolean

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

boolean

ジョブマネージャータスクがスポット/低優先度のコンピュートノード上で実行できるかどうか。 これは既定値は true です。

BatchApplicationPackageReference[]

バッチサービスがコマンドラインを実行する前にコンピュートノードにデプロイするアプリケーションパッケージのリストです。アプリケーションパッケージはタスクワーキングディレクトリではなく、共有ディレクトリにダウンロード・デプロイされます。 したがって、参照されたアプリケーションパッケージがすでにコンピュートノード上にあり、かつ最新のものであれば再ダウンロードされません。コンピュートノード上の既存のコピーが使用されます。 参照されたアプリケーションパッケージがインストールできない場合、例えばパッケージが削除されたりダウンロードに失敗した場合、タスクは失敗します。

AuthenticationTokenSettings

Batch サービス操作の実行にタスクが使用できる認証トークンの設定。 このプロパティが設定されると、バッチサービスはタスクに認証トークンを提供し、アカウントアクセスキーを必要とせずにバッチサービス操作を認証できます。 トークンは、AZ_BATCH_AUTHENTICATION_TOKEN環境変数を介して提供されます。 タスクがトークンを使って実行できる操作は設定によって異なります。 例えば、タスクはジョブ権限を要求して他のタスクを追加したり、ジョブやジョブ内の他のタスクの状態を確認したりできます。

string

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

BatchTaskConstraints

ジョブマネージャータスクに適用される制約。

BatchTaskContainerSettings

ジョブマネージャータスクが動作するコンテナの設定。 このタスクを実行するプールがcontainerConfiguration setを持っていれば、これも設定しなければなりません。 このタスクを実行するプールにcontainerConfigurationが設定されていなければ、この設定はできません。 これが指定されると、ノード上のAzure BatchディレクトリのルートであるAZ_BATCH_NODE_ROOT_DIRより下のすべてのディレクトリが再帰的にコンテナにマッピングされ、すべてのタスク環境変数がコンテナにマッピングされ、タスクコマンドラインがコンテナ内で実行されます。 AZ_BATCH_NODE_ROOT_DIR以外のコンテナで生成されたファイルはホストディスクに反映されない可能性があり、バッチファイルのAPIはそれらのファイルにアクセスできません。

string

ジョブマネージャータスクの表示名。 一意である必要はなく、最大1024までの任意のUnicode文字を含めます。

EnvironmentSetting[]

ジョブマネージャータスクの環境変数設定の一覧です。

string

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

boolean

ジョブマネージャータスクの完了が全体のジョブ完了を意味するかどうか。 もしこれが正しければ、ジョブマネージャータスクが完了するとバッチサービスはジョブを完了としてマークします。 もしこの時点でまだ実行中のタスク(ジョブリリース以外)があれば、それらのタスクは終了します。 もし誤りの場合、ジョブマネージャータスクの完了はジョブステータスに影響を与えません。 この場合、onAllTasksComplete属性を使ってジョブを終了するか、クライアントやユーザーに明示的にジョブを終了させるべきです。 例えば、ジョブマネージャーがタスクのセットを作成しても、その後実行に関与しない場合が挙げられます。 これは既定値は true です。 もしonAllTasksCompleteとonTaskFailure属性を使ってジョブライフタイムを制御し、ジョブマネージャータスクはジョブのタスク作成のみに使っている場合(進捗監視のためではありません)、killJobOnCompletionをfalseに設定することが重要です。

OutputFile[]

コマンドラインを実行した後、バッチサービスがコンピュートノードからアップロードするファイルのリストです。 マルチインスタンスタスクの場合、ファイルはプライマリタスクが実行されるコンピュートノードからのみアップロードされます。

integer (int32)

タスクが実行するために必要なスケジューリングスロットの数。 既定値は 1 です。 タスクは、ノードに十分な空きスケジューリングスロットがある場合に限り、そのノードで実行をスケジューリングできます。 マルチインスタンスタスクの場合、このプロパティはサポートされておらず、指定してはいけません。

ResourceFile[]

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

boolean

ジョブマネージャータスクが実行されるコンピュートノードの排他使用を必要とするかどうか。 もしそうであれば、ジョブマネージャーが動作している間、他のタスクは同じノード上で実行されません。 もし誤りの場合、他のタスクはコンピュートノード上のジョブマネージャーと同時に実行されることがあります。 ジョブマネージャータスクは通常、計算ノードの同時タスク制限にカウントされるため、計算ノードが複数の同時タスクを許可している場合にのみ関係します。 これは既定値は true です。

UserIdentity

ジョブマネージャータスクが実行されるユーザーIDです。 省略すると、タスクはタスク固有の非管理者ユーザーとして動作します。

boolean

ジョブが終了または削除されたときに、仮想ネットワークから DNC にコンピューティング ノードを取り消すかどうか。 true の場合、ノードは仮想ネットワークに DNC に参加したままです。 false の場合、ノードはジョブの終了時に自動的に取り消されます。 既定は false です。

string

ジョブからタスクを実行しているコンピューティング ノードがタスクの期間中参加する仮想ネットワーク サブネットの ARM リソース識別子。 仮想ネットワークは、Azure Batch アカウントと同じリージョンとサブスクリプションに存在する必要があります。 指定されたサブネットには、ジョブからタスクを実行するコンピューティング ノードの数に対応できる十分な空き IP アドレスが必要です。 これは、プール内のコンピューティング ノードの数までです。 Azure Batch サービスがノードでタスクをスケジュールできるように、"MicrosoftAzureBatch" サービス プリンシパルには、指定された VNet の "クラシック仮想マシン共同作成者" Role-Based アクセス制御 (RBAC) ロールが必要です。 これは、指定された VNet にネットワーク セキュリティ グループ (NSG) が関連付けられているかどうかを確認することで確認できます。 指定したサブネット内のノードへの通信が NSG によって拒否された場合、Batch サービスはコンピューティング ノードの状態を使用不可に設定します。 これは、/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet} の形式です。 指定した VNet にネットワーク セキュリティ グループ (NSG) が関連付けられている場合は、Azure Batch サービスからの受信通信のために、いくつかの予約済みシステム ポートを有効にする必要があります。 仮想マシン構成で作成されたプールの場合は、ポート 29876 と 29877、Linux の場合はポート 22、Windows の場合はポート 3389 を有効にします。 ポート 443 は、Azure Storage への通信の送信接続にも開いている必要があります。 詳細については、https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configurationを参照してください。

string

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

BatchTaskConstraints

ジョブ準備タスクに適用される制約条件。

BatchTaskContainerSettings

ジョブ準備タスクが実行されるコンテナの設定。 これが指定されると、ノード上のAzure BatchディレクトリのルートであるAZ_BATCH_NODE_ROOT_DIRより下のすべてのディレクトリが再帰的にコンテナにマッピングされ、すべてのタスク環境変数がコンテナにマッピングされ、タスクコマンドラインがコンテナ内で実行されます。 AZ_BATCH_NODE_ROOT_DIR以外のコンテナで生成されたファイルはホストディスクに反映されない可能性があり、バッチファイルのAPIはそれらのファイルにアクセスできません。

EnvironmentSetting[]

ジョブ準備タスクの環境変数設定の一覧です。

string

ジョブ内のジョブ準備タスクを一意に識別する文字列です。 IDはハイフンやアンダースコアを含む英数字の任意の組み合わせを含み、64文字を超えてはなりません。 このプロパティを指定しない場合、バッチサービスはデフォルトの値として「ジョブ準備」を割り当てます。 ジョブ内の他のタスクはジョブ準備タスクと同じIDを持つことはできません。 同じIDでタスクを送信しようとすると、バッチサービスはエラーコードTaskIdSameAsJobPreparationTaskでリクエストを拒否します。REST APIを直接呼び出す場合、HTTPステータスコードは409(Conflict)です。

boolean

Compute Nodeが再起動した後にバッチサービスがジョブ準備タスクを再実行すべきかどうか。 ジョブ準備タスクは、計算ノードが再イメージ化された場合や、ジョブ準備タスクが完了しなかった場合(例:タスク実行中に再起動が発生した場合)には常に再実行されます。 したがって、ジョブ準備タスクは必ず冪等性を持ち、複数回実行した場合に正しく動作するように書くべきです。 これは既定値は true です。

ResourceFile[]

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

UserIdentity

ジョブ準備タスクが実行されるユーザーIDです。 省略すると、タスクはWindowsコンピュートノード上のタスク固有の非管理者ユーザーとして、またはLinuxのコンピュートノードのプール固有の非管理者ユーザーとして実行されます。

boolean

バッチサービスはジョブ準備タスクが成功裏に完了するまで待ってから、他のジョブのタスクをコンピュートノード上でスケジューリングすべきかどうか。 ジョブ準備タスクが終了すると、終了コード0で成功裏に完了したとみなされます。 もし真でジョブ準備タスクがノード上で失敗した場合、バッチサービスは制約要素で指定された最大リトライ回数までジョブ準備タスクを再試行します。 すべての再トライしてもタスクが成功していない場合、バッチサービスはジョブのタスクをノードにスケジューリングしません。 ノードは引き続きアクティブであり、他のジョブのタスクを実行する資格があります。 もし誤りの場合、バッチサービスはジョブ準備タスクの完了を待ちません。 この場合、ジョブの他のタスクはジョブ準備タスクが実行中である間にコンピュートノード上で実行を開始できます。ジョブ準備タスクが失敗しても、新しいタスクはコンピュートノード上でスケジューリングされ続けます。 これは既定値は true です。

string

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

BatchTaskContainerSettings

ジョブリリースタスクが実行されるコンテナの設定。 これが指定されると、ノード上のAzure BatchディレクトリのルートであるAZ_BATCH_NODE_ROOT_DIRより下のすべてのディレクトリが再帰的にコンテナにマッピングされ、すべてのタスク環境変数がコンテナにマッピングされ、タスクコマンドラインがコンテナ内で実行されます。 AZ_BATCH_NODE_ROOT_DIR以外のコンテナで生成されたファイルはホストディスクに反映されない可能性があり、バッチファイルのAPIはそれらのファイルにアクセスできません。

EnvironmentSetting[]

ジョブリリースタスクの環境変数設定の一覧です。

string

ジョブ内のジョブリリースタスクを一意に識別する文字列です。 IDはハイフンやアンダースコアを含む英数字の任意の組み合わせを含み、64文字を超えてはなりません。 このプロパティを指定しない場合、バッチサービスはデフォルトの値として「ジョブリリース」を割り当てます。 ジョブ内の他のタスクはジョブリリースタスクと同じIDを持つことはできません。 同じIDでタスクを送信しようとすると、バッチサービスはエラーコードTaskIdSameAsJobReleaseTaskでリクエストを拒否します。REST APIを直接呼び出す場合、HTTPステータスコードは409(Conflict)です。

string (duration)

ジョブリリースタスクが特定の計算ノード上で実行可能な最大経過時間(タスク開始時から測定)。 タスクが期限内に完了しない場合、バッチサービスはタスクを終了します。 既定値は 15 分です。 15分を超えるタイムアウトは指定できません。 もしそうすると、バッチサービスはエラーを出して拒否します。REST APIを直接呼び出している場合、HTTPステータスコードは400(Bad Request)です。

ResourceFile[]

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

string (duration)

Compute Node上のジョブリリースタスクのタスクディレクトリを保持する最小時間。 この時間が経過すると、バッチサービスはタスクディレクトリとそのすべての内容を削除することができます。 デフォルトは7日間で、つまりCompute Nodeが削除されるかジョブが削除されない限り、タスクディレクトリは7日間保持されます。

UserIdentity

ジョブリリースタスクが実行されるユーザー識別番号。 省略すると、タスクはタスク固有の非管理者ユーザーとして動作します。

string

メタデータ項目の名前。

string

メタデータ項目の値。

string (arm-id)

ユーザー割り当て ID の ARM リソース ID。

BatchNodePlacementPolicyType

Batch プールでのノード配置ポリシーの種類。 ノードをプロビジョニングするために Batch Service によって使用される割り当てポリシー。 指定しない場合、Batch はリージョン ポリシーを使用します。

CachingType

キャッシュ要件を指定します。 使用できる値は None、ReadOnly、ReadWrite です。 既定値は、Standard Storage の場合は [なし] です。 Premium Storage の ReadOnly。

integer (int32)

新しい OS ディスクを作成するときの初期ディスク サイズ (GB)。

BatchDiffDiskSettings

コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。

ManagedDisk

マネージド ディスクのパラメーター。

boolean

ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

BatchInboundNatPool[]

外部の個々のコンピュートノード上の特定のポートをアドレス指定するために使用できる受信NATプールのリストです。 バッチプールあたりの最大受信NATプール数は5つです。 受信NATプールの最大数を超えると、HTTPステータスコード400でリクエストが失敗します。 IPAddressProvisioningType が NoPublicIPAddresses の場合、これは指定できません。

string (arm-id)

ユーザー割り当て ID の ARM リソース ID。 この参照は、プール ID に含める必要があります。

BatchAutoPoolSpecification

一時的な「オートプール」の特徴。 Batch サービスは、ジョブの送信時にこの自動プールを作成します。 自動プール作成が失敗した場合、バッチサービスはジョブを完了状態に移動させ、ジョブのスケジューリングエラープロパティにプール作成エラーを設定します。 バッチサービスはオートプールのライフ期間(作成およびkeepAliveが指定されていない場合は削除)を管理します。 ジョブがアクティブな間、オートプールの寿命に影響を与えるユーザーの操作は予期せぬ動作を引き起こします。 プールIDか自動プールの仕様のいずれかを指定する必要がありますが、両方は指定できません。

string

既存のプールのIDです。 ジョブのすべてのタスクは指定されたプール上で実行されます。 この物件で言及されているプールが存在することを必ず確認してください。 バッチサービスがジョブをスケジューリングしようとした時点でプールが存在しなければ、そのIDでプールを作成するまでジョブのタスクは実行されません。バッチサービスはジョブ要求を拒否しません。プールが存在するまでタスクを実行しません。 プールIDか自動プールの仕様のいずれかを指定する必要がありますが、両方は指定できません。

BatchApplicationPackageReference[]

プール内の各コンピューティング ノードにインストールするパッケージの一覧。 プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。

string (duration)

自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

string

プール内のコンピューティング ノードの目的の数の数式。 enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 数式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。

string

プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。

boolean

プール サイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合は、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合は、autoScaleFormula 要素が必要です。 プールは、数式に従って自動的にサイズ変更されます。 既定値は false です。

boolean

プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。

BatchMetadataItem[]

メタデータとしてプールに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。

MountConfiguration[]

プール内の各ノードにマウントするファイル システムの一覧。 これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。

NetworkConfiguration

プールのネットワーク構成。

string (duration)

プールへのコンピューティング ノードの割り当てのタイムアウト。 このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合、効果はありません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

BatchStartTask

プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。

integer (int32)

プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。

integer (int32)

プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。

BatchTaskSchedulingPolicy

プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。

integer (int32)

プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。

UpgradePolicy

プールのアップグレード ポリシー。 アップグレード ポリシー (自動、手動、またはローリング) について説明します。

UserAccount[]

プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。

VirtualMachineConfiguration

プールの仮想マシン構成。 このプロパティの指定は必須です。

string

プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 プールで使用可能な仮想マシンのサイズについては、「Azure Batch プールのコンピューティング ノードの VM サイズの選択 (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。

string[] (arm-id)

Batch サービスがコンピューティング ノードのプロビジョニング時に使用するパブリック IP の一覧。 ここで指定する IP の数によって、プールの最大サイズが制限されます。パブリック IP ごとに 100 個の専用ノードまたは 100 個のスポット/低優先度ノードを割り当て可能です。 たとえば、250 個の専用 VM を必要とするプールには、少なくとも 3 つのパブリック IP が指定されている必要があります。 このコレクションの各要素は、/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip} の形式です。

IPFamily[]

プールで使用可能な IP バージョンを指定するために使用される IP ファミリ。 IP ファミリは、シングルスタックまたはデュアルスタックプールを決定するために使用されます。 単一スタックの場合、予期される値は IPv4 です。 デュアル スタックの場合、想定される値は IPv4 と IPv6 です。

IPTag[]

プールのパブリックIPアドレスに関連付けられたIPタグのリスト。 IP タグは、課金および管理の目的でパブリック IP アドレスを分類およびフィルタリングするために使用されます。

IpAddressProvisioningType

プールのパブリック IP アドレスのプロビジョニングの種類。 既定値は BatchManaged です。

string

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

BatchTaskContainerSettings

StartTaskが動作するコンテナの設定。 これが指定されると、ノード上のAzure BatchディレクトリのルートであるAZ_BATCH_NODE_ROOT_DIRより下のすべてのディレクトリが再帰的にコンテナにマッピングされ、すべてのタスク環境変数がコンテナにマッピングされ、タスクコマンドラインがコンテナ内で実行されます。 AZ_BATCH_NODE_ROOT_DIR以外のコンテナで生成されたファイルはホストディスクに反映されない可能性があり、バッチファイルのAPIはそれらのファイルにアクセスできません。

EnvironmentSetting[]

StartTask の環境変数設定の一覧。

integer (int32)

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

ResourceFile[]

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

UserIdentity

StartTaskが動作するユーザーIDです。 省略すると、タスクはタスク固有の非管理者ユーザーとして動作します。

boolean

コンピューティング ノードでタスクをスケジュールする前に、Batch サービスが StartTask が正常に完了するまで (つまり、終了コード 0 で終了する) のを待つ必要があるかどうか。 True で、ノードで StartTask が失敗した場合、Batch サービスは StartTask を最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはノードを使用不可としてマークし、タスクをスケジュールしません。 この状態は、コンピューティング ノードの状態とエラー情報の詳細を使用して検出できます。 false の場合、Batch サービスは StartTask の完了を待機しません。 この場合、StartTask がまだ実行されている間に、コンピューティング ノードで他のタスクの実行を開始できます。StartTask が失敗した場合でも、新しいタスクはコンピューティング ノードで引き続きスケジュールされます。 既定値は true です。

integer (int32)

タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。 この値は、非ゼロの終了コードによりタスク実行ファイルの再試行回数を具体的に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が0の場合、バッチサービスは最初の試み以降タスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、これは開始タスクまたはタスクには推奨されません。 既定値は 0 (再試行なし) です。

string (duration)

タスクが開始した時点から測定される最大経過時間。 タスクが期限内に完了しない場合、バッチサービスはタスクを終了します。 これが指定されていない場合、タスクの実行時間に制限はありません。

string (duration)

実行完了時点から、Compute Node上でタスクディレクトリを保持する最小時間。 この時間が経過すると、バッチサービスはタスクディレクトリとそのすべての内容を削除することができます。 デフォルトは7日間で、つまりCompute Nodeが削除されるかジョブが削除されない限り、タスクディレクトリは7日間保持されます。

ContainerHostBatchBindMountEntry[]

コンテナー タスクにマウントするパス。 この配列が null または存在しない場合、コンテナー タスクは一時ディスク ドライブ全体を Windows (または Linux では AZ_BATCH_NODE_ROOT_DIR) にマウントします。 この配列が空として設定されている場合、データ パスはコンテナーにマウントされません。

string

コンテナー作成コマンドの追加オプション。 これらの追加オプションは、Batch サービスによって制御されるオプションに加えて、"docker create" コマンドの引数として提供されます。

string

タスクを実行するコンテナを作成するために使うイメージ。 これは「docker pull」で指定される完全なイメージ参照です。 画像名にタグが記載されていない場合は、デフォルトとして「:latest」タグが使われます。

ContainerRegistryReference

コンテナイメージを含むプライベートレジストリです。 この設定はプール作成時にすでに提供されていた場合は省略しても構いません。

ContainerWorkingDirectory

コンテナタスクワーキングディレクトリの場所。 既定値は 'taskWorkingDirectory' です。

BatchJobDefaultOrder

同じ優先度を持つ異なるジョブのタスクをスケジューリングする順序。 指定しない場合、デフォルトは none です。

BatchNodeFillType

プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。

boolean

仮想マシンでセキュア ブートを有効にするかどうかを指定します。

boolean

仮想マシンで vTPM を有効にするかどうかを指定します。

SecurityEncryptionTypes

マネージド ディスクの EncryptionType を指定します。 VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly に、VMGuestState BLOB にファームウェアの状態を保持しない場合は NonPersistedTPM に設定されます。 注: これは機密 VM に対してのみ設定でき、機密 VM を使用する場合に必要です。

string

コミュニティギャラリーの画像ユニーク識別子。 このプロパティは他のプロパティと相互に排他的であり、コミュニティ ギャラリー イメージの GET 呼び出しからフェッチできます。

string

ノード作成に使われたプラットフォーム画像やマーケットプレイス画像の特定のバージョン。 この読み取り専用フィールドは、プール作成時に指定された「バージョン」の値が「最新」である場合にのみ「バージョン」と異なります。

string

Azure Virtual Machines Marketplace Imageのオファータイプ。 たとえば、UbuntuServer や WindowsServer などです。

string

Azure Virtual Machines Marketplace Imageの発行者。 たとえば、Canonical または MicrosoftWindowsServer です。

string

共有ギャラリー画像のユニーク識別子。 このプロパティは他のプロパティと相互に排他的であり、共有ギャラリー イメージの GET 呼び出しからフェッチできます。

string

Azure Virtual Machines Marketplace ImageのSKUです。 たとえば、18.04-LTS や 2019-Datacenter などです。

string

Azure Virtual Machines Marketplace Imageのバージョンです。 最新の画像を選択するために「最新」の値を指定できます。 省略した場合、既定値は 'latest' です。

string (arm-id)

Azure コンピューティング ギャラリー イメージの ARM リソース識別子。 プール内の計算ノードはこのイメージIDを使って作成されます。これは、常に最新の画像バージョンをデフォルトで設定するために、/subscriptions/{subscriptionId}/resourceGroups/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} または /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} の形で、常に最新の画像バージョンをデフォルトで使用します。 この性質は他のImageReferenceプロパティとは相反します。 Azure Compute Gallery Imageは、同じリージョン内のレプリカを持ち、Azure Batchアカウントと同じサブスクリプションに属している必要があります。 imageIdに画像バージョンが指定されていない場合は、最新バージョンが使用されます。 バッチコンピュートノードエージェントがバッチサービスと通信するためのファイアウォール設定については https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configurationを参照してください。

string

mount コマンドに渡す追加のコマンド ライン オプション。 これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。

string (password)

CIFS ファイル システムに対する認証に使用するパスワード。

string

ファイルシステムがマウントされる計算ノード上の相対パスです。 すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。

string

マウントするファイル システムの URI。

string

CIFS ファイル システムに対する認証に使用するユーザー。

boolean

このソース パスを読み取り専用モードとしてマウントするかどうか。 既定値は false (読み取り/書き込みモード) です。 Linux の場合、このパスを読み取り/書き込みモードとしてマウントした場合、コンテナー内のすべてのユーザーがパスの読み取り/書き込みアクセス権を持っているわけではありません。これは、ホスト VM のアクセスに依存します。 このパスが読み取り専用でマウントされている場合、コンテナー内のすべてのユーザーはパスを変更できません。

ContainerHostDataPath

コンテナー顧客にマウントするパスを選択できます。

BatchNodeIdentityReference

ユーザー名とパスワードではなく、Azure Container Registry へのアクセスに使用するユーザー割り当て ID への参照。

string (password)

レジストリ サーバーにログインするためのパスワード。

string (uri)

レジストリ URL。 省略した場合、既定値は "docker.io" です。

string

レジストリ サーバーにログインするユーザー名。

CachingType

データ ディスクに対して有効にするキャッシュの種類。 キャッシュの既定値は readwrite です。 キャッシュ オプションの詳細については、「https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/」を参照してください。

integer (int32)

初期ディスク サイズ (ギガバイト単位)。

integer (int32)

論理ユニット番号。 logicalUnitNumber は、各データ ディスクを一意に識別するために使用されます。 複数のディスクを接続する場合は、それぞれが個別の logicalUnitNumber を持つ必要があります。 値は、0 ~ 63 の範囲である必要があります。

ManagedDisk

マネージド ディスクのパラメーター。

StorageAccountType

データ ディスクに使用するストレージ アカウントの種類。 省略した場合、既定値は "standard_lrs" です。

BatchPoolIdentityReference

ディスクを暗号化するためのプール ID の 1 つの参照。 この ID は、KeyVault へのアクセスに使用されます。

string

KeyVault のキーを指す完全バージョン管理されたキー URL。 url のバージョン セグメントは、rotationToLatestKeyVersionEnabled 値に関係なく必要です。

boolean

このフラグを true に設定すると、ディスク暗号化が最新のキーバージョンに自動更新されます。 既定値は false です。

DiskCustomerManagedKey

OS ディスクを暗号化するためのカスタマー マネージド キー参照。 カスタマー マネージド キーは EncryptionAtRest によって OS ディスクを暗号化し、既定ではデータ ディスクも暗号化します。 プールが ID で構成され、OsDisk が DiskEncryption のターゲットの 1 つとして設定されている場合にのみ使用できます。

DiskEncryptionTarget[]

Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。 Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。

string (arm-id)

ディスク暗号化セットの ARM リソース ID。 リソースは、Batch アカウントと同じサブスクリプションにある必要があります。

string

環境変数の名前。

string

環境変数の値。

string

InVMAccessControlProfileVersion リソース ID への参照を、/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} の形式で指定します。

HostEndpointSettingsModeTypes

アクセス制御ポリシーの実行モードを指定します。

string

IP タグの種類。 例: FirstPartyUsage。

string

パブリック IP に関連付けられている IP タグの値。 例: SQL。

integer (int32)

ユーザーアカウントのグループID。 uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは gid を選択します。

string (password)

ユーザーアカウントのSSH秘密鍵です。 秘密キーはパスワードで保護しないでください。 秘密鍵は、Linuxプール内のeableInterNodeCommunicationプロパティが真である場合(enableInterNodeCommunicationが偽の場合は無視)、Linuxプール内のCompute Node間のSSHの非対称鍵認証を自動的に設定するために使われます。 これを行うには、キー ペアをユーザーの .ssh ディレクトリに配置します。 指定がない場合、Compute Node間でパスワードレスSSHは設定されません(ユーザーの.sshディレクトリの変更は行われません)。

integer (int32)

ユーザーアカウントのユーザーID。 uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは uid を選択します。

DiskEncryptionSetParameters

マネージド ディスクのカスタマー マネージド ディスク暗号化セットのリソース ID を指定します。 UserSubscriptionモードでのみ設定できます。

BatchVmDiskSecurityProfile

マネージド ディスクのセキュリティ プロファイル設定を指定します。

StorageAccountType

マネージド ディスクのストレージ アカウントの種類。

AzureBlobFileSystemConfiguration

各ノードで BLOB FUSE を使用してマウントする Azure Storage コンテナー。 このプロパティは、他のすべてのプロパティと相互に排他的です。

AzureFileShareConfiguration

各ノードにマウントする Azure ファイル共有。 このプロパティは、他のすべてのプロパティと相互に排他的です。

CifsMountConfiguration

各ノードにマウントする CIFS/SMB ファイル システム。 このプロパティは、他のすべてのプロパティと相互に排他的です。

NfsMountConfiguration

各ノードにマウントする NFS ファイル システム。 このプロパティは、他のすべてのプロパティと相互に排他的です。

DynamicVNetAssignmentScope

動的 vnet 割り当てのスコープ。

boolean

このプールで高速ネットワークを有効にする必要があるかどうか。 高速ネットワークにより、VM への単一ルート I/O 仮想化 (SR-IOV) が可能になり、ネットワーク パフォーマンスが向上する可能性があります。 詳細については、https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overviewを参照してください。

BatchPoolEndpointConfiguration

バッチプール内のCompute Node上のエンドポイントの設定。

BatchPublicIpAddressConfiguration

Batch プール内のコンピューティング ノードのパブリック IP アドレス構成。

string

プールのコンピュートノードが参加する仮想ネットワークサブネットのARMリソース識別子です。 これは、/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet} の形式です。 仮想ネットワークは、Azure Batch アカウントと同じリージョンとサブスクリプションに存在する必要があります。 指定されたサブネットには、プール内のコンピュートノード数を収容できる十分な空きIPアドレスが必要です。 サブネットに十分な空きIPアドレスがない場合、プールはノードを部分的に割り当て、リサイズエラーが発生します。 "MicrosoftAzureBatch" サービス プリンシパルには、指定された VNet の "クラシック仮想マシン共同作成者" Role-Based アクセス制御 (RBAC) ロールが必要です。 指定されたサブネットは、ノード上でタスクをスケジュールできるよう、Azure Batchサービスからの通信を許可しなければなりません。 これは、指定された VNet にネットワーク セキュリティ グループ (NSG) が関連付けられているかどうかを確認することで確認できます。 指定したサブネット内のノードへの通信が NSG によって拒否された場合、Batch サービスはコンピューティング ノードの状態を使用不可に設定します。 サポートされているのはARM仮想ネットワーク(「Microsoft.Network/virtualNetworks」)のみです。 指定されたVNetに関連するネットワークセキュリティグループ(NSG)がある場合、受信通信用にいくつかの予約済みシステムポート(ポート29876および29877を含む)を有効にしなければなりません。 また、ポート 443 で Azure Storage への送信接続を有効にします。 詳細については、次を参照してください: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRuleAccess

指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。

integer (int32)

このルールの優先順位。 プール内の優先順位は一意でなければならず、優先順位で評価されます。 数値が小さい方が優先度が高くなります。 たとえば、順序番号が 150、250、350 のルールを指定できます。 順序番号が 150 のルールは、順序が 250 のルールよりも優先されます。 許可される優先順位は 150 から 4096 です。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。

string

ルールに一致する送信元アドレスプレフィックスまたはタグ。 有効な値は、1 つの IP アドレス (10.10.10.10.10)、IP サブネット (つまり 192.168.1.0/24)、既定のタグ、または * (すべてのアドレスの場合) です。 その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。

string[]

規則に一致するソース ポートの範囲。 有効な値は「'」(すべてのポート0から65535)、特定のポート(例:22)、またはポート範囲(例:100-200)です。ポートは0から65535の範囲でなければなりません。このコレクションの各エントリーは、他のエントリー(レンジまたは個別のポート)と重複してはなりません。他に値が提供された場合、リクエストはHTTPステータスコード400で失敗します。デフォルト値は「」です。

string

mount コマンドに渡す追加のコマンド ライン オプション。 これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。

string

ファイルシステムがマウントされる計算ノード上の相対パスです。 すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。

string

マウントするファイル システムの URI。

OutputFileDestination

出力ファイルの宛先。

string

どのファイルをアップロードすべきかを示すパターンです。 相対経路と絶対経路の両方がサポートされています。 相対パスはタスクワーキングディレクトリに対して相対的なものです。 以下のワイルドカードがサポートされています:* は0文字以上と一致します(例えば、パターン abc* は abc または abcdef と一致します)、** は任意のディレクトリにマッチします、? 任意の単一文字、[abc]が括弧内の1文字、[a-c]が範囲内の1文字と一致します。 括弧には、指定されていない文字に一致する否定を含めることができます(例:[!abc]はa、b、c以外の任意の文字と一致します)。 ファイル名が「.」で始まる場合はデフォルトでは無視されますが、明示的に指定することでマッチング可能です(例えば、 .gif は .a.gifと一致しませんが、.gif は一致します)。 簡単な例として、***.txt は '.' で始まらず、タスクワーキングディレクトリまたは任意のサブディレクトリで終わる .txt ファイルとマッチします。 ファイル名にワイルドカード文字が含まれている場合、括弧で脱出できます(例えば、abc[]はabcというファイルと一致します)。 なお、Windowsでは\と/の両方がディレクトリ区切りとして扱われますが、Linuxでは/のみが使われます。 環境変数(Windowsでは%var%、Linuxでは$var)はパターンを適用する前に展開されます。

OutputFileUploadConfig

アップロード操作の追加オプション、どのような条件下でアップロードを行うかなど。

string (uri)

ファイルをアップロードするためのAzure Blob Storage内のコンテナのURLです。 管理型アイデンティティを使用していない場合、URLにはコンテナへの書き込み権限を与える共有アクセス署名(SAS)が含まれなければなりません。

BatchNodeIdentityReference

containerUrlで指定されたAzure Blob Storageにアクセスするために使うユーザー割り当てのアイデンティティを参照します。 アイデンティティはAzure Blob Storageコンテナへの書き込みアクセス権を持っている必要があります。

string

Azure Storage コンテナ内の宛先 blob または仮想ディレクトリです。 filePatternが特定のファイル(ワイルドカードを含まない)を指す場合、pathはそのファイルをアップロードするブロブの名前です。 filePatternに1つ以上のワイルドカードが含まれ(複数のファイルに対応する場合)、pathはファイルをアップロードするためのブロブ仮想ディレクトリの名前(各ブロブ名の前に付加される)です。 省略された場合、ファイルはファイル名に一致するブロブ名でコンテナのルートにアップロードされます。

OutputFileUploadHeader[]

出力ファイルのアップロードに使用されるヘッダーの名前と値の組み合わせのリスト。 これらのヘッダーは、Azure Storageへのアップロード時に指定されます。 ブロブアップロード時に許可されるヘッダーに関する公式ドキュメント: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types。

OutputFileBlobContainerDestination

ファイルをアップロードするAzureのBlobストレージ内の場所です。

OutputFileUploadCondition

タスク出力ファイルまたはファイル群がアップロードされるべき条件。 デフォルトはタスク完了です。

string

出力ファイルのアップロード時に使用するヘッダーの大文字を区別しない名前です。

string

出力ファイルのアップロード時に使用するヘッダーの値。

boolean

メタデータ セキュリティ プロトコル機能を仮想マシンまたは仮想マシン スケール セットのどちらで有効にするかを指定します。 既定値は False です。

HostEndpointSettings

IMDS エンドポイントの設定。

HostEndpointSettings

WireServer エンドポイントの設定。

string

自動ストレージアカウントのストレージコンテナ名です。 autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。

string

Azure Storage コンテナーから BLOB をダウンロードするときに使用する BLOB プレフィックス。 指定したプレフィックスで始まる名前の BLOB のみがダウンロードされます。 このプロパティは、autoStorageContainerName または storageContainerUrl が使用されている場合にのみ有効です。 このプレフィックスには、部分的なファイル名またはサブディレクトリを指定できます。 プレフィックスが指定されていない場合は、コンテナー内のすべてのファイルがダウンロードされます。

string

ファイルアクセス許可モード属性 (8 進数形式)。 この特性は、Linux Compute Nodesにダウンロードされるファイルにのみ適用されます。 WindowsのCompute NodeにダウンロードされるresourceFileに指定されている場合は無視されます。 このプロパティがLinuxのコンピュートノードに指定されていない場合、ファイルにはデフォルト値0770が適用されます。

string

タスクの作業ディレクトリに対してファイルをダウンロードするためのComputeノード上の位置。 httpUrl プロパティが指定されている場合、filePath は必須であり、ファイルのダウンロード先となるパス (ファイル名を含む) を記述します。 それ以外の場合、autoStorageContainerName または storageContainerUrl プロパティが指定されている場合、filePath は省略可能であり、ファイルをダウンロードするディレクトリです。 filePath がディレクトリとして使用されている場合、入力データに既に関連付けられているディレクトリ構造は完全に保持され、指定された filePath ディレクトリに追加されます。 指定された相対パスはタスクの作業ディレクトリから抜け出すことはできません(例えば「..」を使うなど)。

string (uri)

ダウンロードするファイルの URL。 autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 URL が Azure Blob Storage を指している場合は、コンピューティング ノードから読み取ることができる必要があります。 Azure Storage 内の BLOB のこのような URL を取得するには、3 つの方法があります。BLOB に対する読み取りアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りアクセス許可を持つマネージド ID を使用するか、BLOB またはそのコンテナーの ACL を設定してパブリック アクセスを許可します。

BatchNodeIdentityReference

storageContainerUrlまたはhttpUrlで指定されたAzure Blob Storageにアクセスするために使うユーザー割り当てのIDを参照します。

string (uri)

Azure Blob Storage 内の BLOB コンテナーの URL。 autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 この URL は、コンピューティング ノードから読み取り可能でリスト可能である必要があります。 Azure Storage 内のコンテナーのこのような URL を取得するには、3 つの方法があります。コンテナーに対する読み取りと一覧表示のアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りとリストのアクセス許可を持つマネージド ID を使用するか、コンテナーの ACL を設定してパブリック アクセスを許可します。

boolean

アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、更新ドメインと maxBatchInstancePercent を考慮してください。 このフィールドは、NodePlacementConfiguration をゾーンとして使用する場合にのみ true または false に設定できます。

integer (int32)

1 回のバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計数に対する最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。

integer (int32)

アップグレードの結果として、またはローリング アップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計数に対する最大割合。 この制約は、バッチを開始する前にチェックされます。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。

integer (int32)

異常な状態にあると検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に行われます。 この割合を超えた場合、ローリング アップデートは中止されます。 このフィールドの値は、0 ~ 100 の範囲にする必要があります。

string (duration)

すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。

boolean

正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。

boolean

ローリング アップグレード ポリシーに違反した場合、失敗したインスタンスを以前のモデルにロールバックします。

boolean

このプロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。 ホスト要件での暗号化の詳細については、https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizesを参照してください。

ProxyAgentSettings

仮想マシンの作成時に ProxyAgent の設定を指定します。

SecurityTypes

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。

BatchUefiSettings

仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。 仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。

string

ServiceArtifactReferenceのサービスアーティファクト参照IDです。 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス 成果物参照 ID

AutomaticOsUpgradePolicy

OS の自動アップグレードを実行するために使用される構成パラメーター。 OS の自動アップグレードを実行するために使用される構成パラメーター。

UpgradeMode

スケール セット内の仮想マシンへのアップグレード モードを指定します。

使用可能な値は次のとおりです。

手動 - スケール セット内の仮想マシンへの更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。

自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。

ローリング - スケール セットは、必要に応じて一時停止時間の間にバッチで更新を実行します。

RollingUpgradePolicy

ローリング アップグレードの実行中に使用される構成パラメーター。

ElevationLevel

ユーザーアカウントのレベル。 既定値は nonAdmin です。

LinuxUserConfiguration

ユーザーアカウントのLinux固有のユーザー設定。 このプロパティはWindowsプールで指定されている場合は無視されます。 指定しない場合、ユーザーは既定のオプションで作成されます。

string

ユーザーアカウントの名前です。 名前には、最大 20 文字までの Unicode 文字を含めることができます。

string (password)

ユーザーアカウントのパスワードです。

WindowsUserConfiguration

ユーザーアカウントのWindows固有のユーザー設定。 このプロパティは、ユーザーがWindowsプールにいる場合にのみ指定可能です。 指定されていなければ、Windowsプール上でユーザーはデフォルトのオプションで作成されます。

AutoUserSpecification

タスクを実行する自動ユーザーです。 userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。

string

タスクが実行されるユーザーIDの名前。 userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。

BatchContainerConfiguration

プールのコンテナ構成。 指定されている場合、プール内の各コンピュートノードでセットアップが行われ、タスクがコンテナ内で実行できるようにします。 このプール上で動作するすべての通常のタスクおよびジョブマネージャータスクはcontainerSettingsプロパティを指定しなければならず、他のすべてのタスクも指定できます。

DataDisk[]

プール内のComputeノードに接続されたデータディスクの構成。 このプロパティは、プール内のComputeノードに空のデータディスクを接続する必要がある場合に指定する必要があります。 これは更新できません。 各コンピュートノードはそれぞれのディスクを持ちます(ディスクはファイル共有ではありません)。 既存のディスクは接続できず、各ディスクは空です。 Computeノードがプールから削除されると、ディスクおよびそれに関連するすべてのデータも削除されます。 ディスクは接続後にフォーマットされるわけではなく、使用前に必ずフォーマットする必要があります。詳細は「 https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux 」および「 https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine」を参照してください。

DiskEncryptionConfiguration

プールのディスク暗号化構成。 指定した場合、暗号化は、ノードのプロビジョニング中にプール内の各ノードで実行されます。

VMExtension[]

プールの仮想マシン拡張機能。 指定した場合、この構成に記載されている拡張機能が各ノードにインストールされます。

BatchVmImageReference

使用する Azure Virtual Machines Marketplace イメージまたはカスタム仮想マシン イメージへの参照。

string

これはWindowsオペレーティングシステムを含むイメージにのみ適用され、デプロイされるコンピュートノードの有効なオンプレミスライセンスを保有している場合にのみ使用してください。 省略した場合、オンプレミスのライセンス割引は適用されません。 値は次のとおりです。

Windows_Server - オンプレミスライセンスは Windows Server 用です。 Windows_Client - オンプレミス ライセンスは Windows クライアント用です。

string

プール内のコンピューティング ノードにプロビジョニングされる Batch コンピューティング ノード エージェントの SKU。 Batch コンピューティング ノード エージェントは、プール内の各コンピューティング ノードで実行されるプログラムであり、コンピューティング ノードと Batch サービスの間のコマンドアンドコントロール インターフェイスを提供します。 コンピューティング ノード エージェントの実装は、SKU と呼ばれ、オペレーティング システムごとに異なります。 選択したイメージ参照と一致するコンピューティング ノード エージェント SKU を指定する必要があります。 サポートされているコンピューティング ノード エージェント SKU の一覧と検証済みイメージ参照の一覧を取得するには、「サポートされているコンピューティング ノード エージェント SKU の一覧」操作を参照してください。

BatchNodePlacementConfiguration

プールのノード配置構成。 この構成では、プール内のノードを物理的に割り当てる方法に関する規則を指定します。

BatchOsDisk

仮想マシンのオペレーティング システム ディスクの設定。

SecurityProfile

仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。

ServiceArtifactReference

"最新" イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス 成果物参照 ID を指定します。 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス 成果物参照 ID

WindowsConfiguration

仮想マシン上の Windows オペレーティング システムの設定。 imageReferenceプロパティがLinux OSイメージを指定する場合、このプロパティは指定してはいけません。

boolean

展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。

boolean

使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。

string

仮想マシン拡張機能の名前。

object

拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。

string[]

拡張機能名のコレクション。 この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。

string

拡張ハンドラーの発行元の名前。

object

拡張機能の JSON 形式のパブリック設定。

string

拡張機能の種類。

string

スクリプト ハンドラーのバージョン。

boolean

仮想マシンで自動更新が有効になっているかどうか。 省略した場合、既定値は true です。

LoginMode

ユーザーのログインモード。 デフォルトは「バッチ」です。