BatchPoolCreateOptions interface

パッケージ:

@azure/batch

Azure Batch Poolを作成するパラメータ。

プロパティ

applicationPackageReferences	プール内の各コンピューティング ノードにインストールするパッケージの一覧。 プールを作成する際、パッケージのアプリケーションIDは完全限定でなければなりません(/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft)。Batch/batchAccounts/{accountName}/applications/{applicationName})。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。
autoScaleEvaluationInterval	自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 時間の長さはISO 8601形式で規定されています。
autoScaleFormula	プール内のコンピューティング ノードの必要な数の数式。 enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 数式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。 この式の指定についての詳細は、「Azure Batchプール内のCompute Nodesを自動的にスケーリングする」(https://learn.microsoft.com/azure/batch/batch-automatic-scaling)を参照してください。
displayName	プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
enableAutoScale	プール サイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合は、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合、autoScaleFormula プロパティが必要であり、プールは数式に従って自動的にサイズ変更されます。 既定値は false です。
enableInterNodeCommunication	プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。
id	アカウント内のプールを一意に識別する文字列。 ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に、大文字と小文字のみが異なる 2 つのプール ID がない可能性があります)。
metadata	メタデータとしてプールに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
mountConfiguration	プールの存続期間中、指定されたファイルシステムを使用してストレージをマウントします。 ストレージはAzureファイルシェア、NFS、CIFS、またはBlobfuseベースのファイルシステムでマウントしてください。
networkConfiguration	プールのネットワーク構成。
resizeTimeout	プールへのコンピューティング ノードの割り当てのタイムアウト。 このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合、効果はありません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 時間の長さはISO 8601形式で規定されています。
startTask	プールに参加する各コンピューティング ノードで実行するように指定されたタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。
targetDedicatedNodes	プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
targetLowPriorityNodes	プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
taskSchedulingPolicy	プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。
taskSlotsPerNode	プール内の単一の計算ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
upgradePolicy	プールのアップグレード ポリシー。 アップグレード ポリシー (自動、手動、またはローリング) について説明します。
userAccounts	プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。
virtualMachineConfiguration	プールの仮想マシン構成。 このプロパティの指定は必須です。
vmSize	プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 Virtual Machinesマーケットプレイスのイメージ(virtualMachineConfigurationで作成されたプール)を使ったプールの利用可能なVMサイズについては、「AzureのVirtual Machinesサイズ(https://learn.microsoft.com/azure/virtual-machines/sizes/overview)」をご覧ください。 バッチはSTANDARD_A0およびプレミアムストレージ(STANDARD_GS、STANDARD_DS、STANDARD_DSV2シリーズ)を除くすべてのAzure VMサイズをサポートします。

プロパティの詳細

applicationPackageReferences

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

applicationPackageReferences?: BatchApplicationPackageReference[]

プロパティ値

BatchApplicationPackageReference[]

autoScaleEvaluationInterval

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

autoScaleEvaluationInterval?: string

プロパティ値

string

autoScaleFormula

プール内のコンピューティング ノードの必要な数の数式。 enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 数式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。 この式の指定についての詳細は、「Azure Batchプール内のCompute Nodesを自動的にスケーリングする」(https://learn.microsoft.com/azure/batch/batch-automatic-scaling)を参照してください。

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

id

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

id: string

プロパティ値

string

metadata

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

metadata?: BatchMetadataItem[]

プロパティ値

BatchMetadataItem[]

mountConfiguration

プールの存続期間中、指定されたファイルシステムを使用してストレージをマウントします。 ストレージはAzureファイルシェア、NFS、CIFS、またはBlobfuseベースのファイルシステムでマウントしてください。

mountConfiguration?: MountConfiguration[]

プロパティ値

MountConfiguration[]

networkConfiguration

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

networkConfiguration?: NetworkConfiguration

プロパティ値

NetworkConfiguration

resizeTimeout

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

resizeTimeout?: string

プロパティ値

string

startTask

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

startTask?: BatchStartTask

プロパティ値

BatchStartTask

targetDedicatedNodes

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

targetDedicatedNodes?: number

プロパティ値

number

targetLowPriorityNodes

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

targetLowPriorityNodes?: number

プロパティ値

number

taskSchedulingPolicy

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

taskSchedulingPolicy?: BatchTaskSchedulingPolicy

プロパティ値

BatchTaskSchedulingPolicy

taskSlotsPerNode

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

taskSlotsPerNode?: number

プロパティ値

number

upgradePolicy

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

upgradePolicy?: UpgradePolicy

プロパティ値

UpgradePolicy

userAccounts

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

userAccounts?: UserAccount[]

プロパティ値

UserAccount[]

virtualMachineConfiguration

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

virtualMachineConfiguration?: VirtualMachineConfiguration

プロパティ値

VirtualMachineConfiguration

vmSize

プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 Virtual Machinesマーケットプレイスのイメージ(virtualMachineConfigurationで作成されたプール)を使ったプールの利用可能なVMサイズについては、「AzureのVirtual Machinesサイズ(https://learn.microsoft.com/azure/virtual-machines/sizes/overview)」をご覧ください。 バッチはSTANDARD_A0およびプレミアムストレージ(STANDARD_GS、STANDARD_DS、STANDARD_DSV2シリーズ)を除くすべてのAzure VMサイズをサポートします。

vmSize: string

プロパティ値

string