BatchPoolSpecification interface
新しいプールを作成するための仕様。
プロパティ
| application |
プール内の各コンピューティング ノードにインストールするパッケージの一覧。 プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。 |
| auto |
自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 |
| auto |
プール内のコンピューティング ノードの目的の数の数式。 enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 数式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。 |
| display |
プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。 |
| enable |
プール サイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合は、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合は、autoScaleFormula 要素が必要です。 プールは、数式に従って自動的にサイズ変更されます。 既定値は false です。 |
| enable |
プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。 |
| metadata | メタデータとしてプールに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。 |
| mount |
プール内の各ノードにマウントするファイル システムの一覧。 これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。 |
| network |
プールのネットワーク構成。 |
| resize |
プールへのコンピューティング ノードの割り当てのタイムアウト。 このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合、効果はありません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 |
| start |
プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。 |
| target |
プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。 |
| target |
プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。 |
| task |
プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。 |
| task |
プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。 |
| upgrade |
プールのアップグレード ポリシー。 アップグレード ポリシー (自動、手動、またはローリング) について説明します。 |
| user |
プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。 |
| virtual |
プールの仮想マシン構成。 このプロパティの指定は必須です。 |
| vm |
プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 プールで使用可能な仮想マシンのサイズについては、「Azure Batch プールのコンピューティング ノードの VM サイズの選択 (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。 |
プロパティの詳細
applicationPackageReferences
プール内の各コンピューティング ノードにインストールするパッケージの一覧。 プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。
applicationPackageReferences?: BatchApplicationPackageReference[]
プロパティ値
autoScaleEvaluationInterval
自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
autoScaleEvaluationInterval?: string
プロパティ値
string
autoScaleFormula
プール内のコンピューティング ノードの目的の数の数式。 enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 数式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。
autoScaleFormula?: string
プロパティ値
string
displayName
プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
displayName?: string
プロパティ値
string
enableAutoScale
プール サイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合は、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合は、autoScaleFormula 要素が必要です。 プールは、数式に従って自動的にサイズ変更されます。 既定値は false です。
enableAutoScale?: boolean
プロパティ値
boolean
enableInterNodeCommunication
プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。
enableInterNodeCommunication?: boolean
プロパティ値
boolean
metadata
メタデータとしてプールに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
metadata?: BatchMetadataItem[]
プロパティ値
mountConfiguration
プール内の各ノードにマウントするファイル システムの一覧。 これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
mountConfiguration?: MountConfiguration[]
プロパティ値
networkConfiguration
resizeTimeout
プールへのコンピューティング ノードの割り当てのタイムアウト。 このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合、効果はありません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
resizeTimeout?: string
プロパティ値
string
startTask
プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。
startTask?: BatchStartTask
プロパティ値
targetDedicatedNodes
プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
targetDedicatedNodes?: number
プロパティ値
number
targetLowPriorityNodes
プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
targetLowPriorityNodes?: number
プロパティ値
number
taskSchedulingPolicy
プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。
taskSchedulingPolicy?: BatchTaskSchedulingPolicy
プロパティ値
taskSlotsPerNode
プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
taskSlotsPerNode?: number
プロパティ値
number
upgradePolicy
プールのアップグレード ポリシー。 アップグレード ポリシー (自動、手動、またはローリング) について説明します。
upgradePolicy?: UpgradePolicy
プロパティ値
userAccounts
virtualMachineConfiguration
プールの仮想マシン構成。 このプロパティの指定は必須です。
virtualMachineConfiguration?: VirtualMachineConfiguration
プロパティ値
vmSize
プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 プールで使用可能な仮想マシンのサイズについては、「Azure Batch プールのコンピューティング ノードの VM サイズの選択 (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。
vmSize: string
プロパティ値
string