BatchPoolUpdateOptions interface
Azure Batch プールを更新するためのパラメーター。
プロパティ
| application |
プール内の各コンピューティング ノードにインストールするパッケージの一覧。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 この要素が存在する場合は、既存の Package 参照が置き換えられます。 空のコレクションを指定すると、すべてのパッケージ参照がプールから削除されます。 省略すると、既存のパッケージ参照は変更されません。 |
| display |
プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。 このフィールドは、プールが空の場合にのみ更新できます。 |
| enable |
プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。 |
| metadata | メタデータとしてプールに関連付けられている名前と値のペアの一覧。 この要素が存在する場合は、プールで構成されている既存のメタデータが置き換えられます。 空のコレクションを指定すると、すべてのメタデータがプールから削除されます。 省略すると、既存のメタデータは変更されません。 |
| mount |
プールの存続期間中、指定されたファイルシステムを使用してストレージをマウントします。 Azure ファイル共有、NFS、CIFS、または Blobfuse ベースのファイル システムを使用してストレージをマウントします。 |
| network |
プールのネットワーク構成。 このフィールドは、プールが空の場合にのみ更新できます。 |
| start |
プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。 この要素が存在する場合は、既存の StartTask が上書きされます。 省略すると、既存の StartTask は変更されません。 |
| 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
プール内の各コンピューティング ノードにインストールするパッケージの一覧。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 この要素が存在する場合は、既存の Package 参照が置き換えられます。 空のコレクションを指定すると、すべてのパッケージ参照がプールから削除されます。 省略すると、既存のパッケージ参照は変更されません。
applicationPackageReferences?: BatchApplicationPackageReference[]プロパティ値
displayName
プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。 このフィールドは、プールが空の場合にのみ更新できます。
displayName?: stringプロパティ値
string
enableInterNodeCommunication
プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。
このフィールドは、プールが空の場合にのみ更新できます。
enableInterNodeCommunication?: booleanプロパティ値
boolean
metadata
メタデータとしてプールに関連付けられている名前と値のペアの一覧。 この要素が存在する場合は、プールで構成されている既存のメタデータが置き換えられます。 空のコレクションを指定すると、すべてのメタデータがプールから削除されます。 省略すると、既存のメタデータは変更されません。
metadata?: BatchMetadataItem[]プロパティ値
mountConfiguration
プールの存続期間中、指定されたファイルシステムを使用してストレージをマウントします。 Azure ファイル共有、NFS、CIFS、または Blobfuse ベースのファイル システムを使用してストレージをマウントします。
このフィールドは、プールが空の場合にのみ更新できます。
mountConfiguration?: MountConfiguration[]プロパティ値
networkConfiguration
プールのネットワーク構成。 このフィールドは、プールが空の場合にのみ更新できます。
networkConfiguration?: NetworkConfigurationプロパティ値
startTask
プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。 この要素が存在する場合は、既存の StartTask が上書きされます。 省略すると、既存の StartTask は変更されません。
startTask?: BatchStartTaskプロパティ値
taskSchedulingPolicy
プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。
このフィールドは、プールが空の場合にのみ更新できます。
taskSchedulingPolicy?: BatchTaskSchedulingPolicyプロパティ値
taskSlotsPerNode
プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
このフィールドは、プールが空の場合にのみ更新できます。
taskSlotsPerNode?: numberプロパティ値
number
upgradePolicy
プールのアップグレード ポリシー。 アップグレード ポリシー (自動、手動、またはローリング) について説明します。
このフィールドは、プールが空の場合にのみ更新できます。
upgradePolicy?: UpgradePolicyプロパティ値
userAccounts
プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。 このフィールドは、プールが空の場合にのみ更新できます。
userAccounts?: UserAccount[]プロパティ値
virtualMachineConfiguration
プールの仮想マシン構成。 このプロパティの指定は必須です。
このフィールドは、プールが空の場合にのみ更新できます。
virtualMachineConfiguration?: VirtualMachineConfigurationプロパティ値
vmSize
プール内の仮想マシンのサイズ。 プールで使用可能な仮想マシンのサイズについては、「Azure Batch プールのコンピューティング ノードの VM サイズの選択 (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。
このフィールドは、プールが空の場合にのみ更新できます。
vmSize?: stringプロパティ値
string
