PoolSpecification interface

パッケージ:

@azure/batch

PoolSpecification を表すインターフェイス。

プロパティ

applicationLicenses	Batch サービスがプール内の各コンピューティング ノードで使用できるアプリケーション ライセンスの一覧。 アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。 プールで使用できるライセンスは、'maya'、'vray'、'3dsmax'、'arnold' です。 プールに追加されたアプリケーション ライセンスごとに追加料金が適用されます。
applicationPackageReferences	プール内の各コンピューティング ノードにインストールするパッケージの一覧。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。
autoScaleEvaluationInterval	自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
autoScaleFormula	プール内のコンピューティング ノードの目的の数の数式。 enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 数式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。
certificateReferences	プール内の各コンピューティング ノードにインストールする証明書の一覧。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。
cloudServiceConfiguration	プールのクラウド サービス構成。 プールを Azure PaaS VM で作成する必要がある場合は、このプロパティを指定する必要があります。 このプロパティと virtualMachineConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。 どちらも指定されていない場合、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合、このプロパティを指定できません。
displayName	プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
enableAutoScale	プール サイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合、targetDedicateNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合は、autoScaleFormula 要素が必要です。 プールは、数式に従って自動的にサイズ変更されます。 既定値は false です。
enableInterNodeCommunication	プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。
metadata	メタデータとしてプールに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
mountConfiguration	プール内の各ノードにマウントするファイル システムの一覧。 これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
networkConfiguration	プールのネットワーク構成。
resizeTimeout	プールへのコンピューティング ノードの割り当てのタイムアウト。 このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合、効果はありません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
startTask	プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。
targetDedicatedNodes	プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
targetLowPriorityNodes	プール内の優先順位の低いコンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
taskSchedulingPolicy	プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。
taskSlotsPerNode	プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
userAccounts	プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。
virtualMachineConfiguration	プールの仮想マシン構成。 プールを Azure IaaS VM で作成する必要がある場合は、このプロパティを指定する必要があります。 このプロパティと cloudServiceConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。 どちらも指定されていない場合、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
vmSize	プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 プールで使用可能な仮想マシンのサイズについては、「Azure Batch プールのコンピューティング ノードの VM サイズの選択 (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。

プロパティの詳細

applicationLicenses

Batch サービスがプール内の各コンピューティング ノードで使用できるアプリケーション ライセンスの一覧。 アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。 プールで使用できるライセンスは、'maya'、'vray'、'3dsmax'、'arnold' です。 プールに追加されたアプリケーション ライセンスごとに追加料金が適用されます。

applicationLicenses?: string[]

プロパティ値

string[]

applicationPackageReferences

プール内の各コンピューティング ノードにインストールするパッケージの一覧。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。

applicationPackageReferences?: ApplicationPackageReference[]

プロパティ値

ApplicationPackageReference[]

autoScaleEvaluationInterval

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

autoScaleEvaluationInterval?: string

プロパティ値

string

autoScaleFormula

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

autoScaleFormula?: string

プロパティ値

string

certificateReferences

プール内の各コンピューティング ノードにインストールする証明書の一覧。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。

certificateReferences?: CertificateReference[]

プロパティ値

CertificateReference[]

cloudServiceConfiguration

プールのクラウド サービス構成。 プールを Azure PaaS VM で作成する必要がある場合は、このプロパティを指定する必要があります。 このプロパティと virtualMachineConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。 どちらも指定されていない場合、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合、このプロパティを指定できません。

cloudServiceConfiguration?: CloudServiceConfiguration

プロパティ値

CloudServiceConfiguration

displayName

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

displayName?: string

プロパティ値

string

enableAutoScale

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

enableAutoScale?: boolean

プロパティ値

boolean

enableInterNodeCommunication

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

enableInterNodeCommunication?: boolean

プロパティ値

boolean

metadata

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

metadata?: MetadataItem[]

プロパティ値

MetadataItem[]

mountConfiguration

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

mountConfiguration?: MountConfiguration[]

プロパティ値

MountConfiguration[]

networkConfiguration

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

networkConfiguration?: NetworkConfiguration

プロパティ値

NetworkConfiguration

resizeTimeout

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

resizeTimeout?: string

プロパティ値

string

startTask

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

startTask?: StartTask

プロパティ値

StartTask

targetDedicatedNodes

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

targetDedicatedNodes?: number

プロパティ値

number

targetLowPriorityNodes

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

targetLowPriorityNodes?: number

プロパティ値

number

taskSchedulingPolicy

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

taskSchedulingPolicy?: TaskSchedulingPolicy

プロパティ値

TaskSchedulingPolicy

taskSlotsPerNode

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

taskSlotsPerNode?: number

プロパティ値

number

userAccounts

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

userAccounts?: UserAccount[]

プロパティ値

UserAccount[]

virtualMachineConfiguration

プールの仮想マシン構成。 プールを Azure IaaS VM で作成する必要がある場合は、このプロパティを指定する必要があります。 このプロパティと cloudServiceConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。 どちらも指定されていない場合、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

virtualMachineConfiguration?: VirtualMachineConfiguration

プロパティ値

VirtualMachineConfiguration

vmSize

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

vmSize: string

プロパティ値

string