PoolAddParameter interface

パッケージ:

@azure/batch

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

プロパティ

applicationLicenses	Batch サービスがプール内の各コンピューティング ノードで使用できるアプリケーション ライセンスの一覧。 アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。
applicationPackageReferences	プール内の各コンピューティング ノードにインストールするパッケージの一覧。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。
autoScaleEvaluationInterval	自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
autoScaleFormula	プール内のコンピューティング ノードの必要な数の数式。 enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 数式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする」(https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) を参照してください。
certificateReferences	プール内の各コンピューティング ノードにインストールする証明書の一覧。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。
cloudServiceConfiguration	プールのクラウド サービス構成。 このプロパティと virtualMachineConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合、このプロパティを指定できません。
displayName	プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
enableAutoScale	プール サイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合、targetDedicateNodes と 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 (無効な要求) です。
startTask	プールに参加する各コンピューティング ノードで実行するように指定されたタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。
targetDedicatedNodes	プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
targetLowPriorityNodes	プール内の優先順位の低いコンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
taskSchedulingPolicy	プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。
taskSlotsPerNode	プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
userAccounts	プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。
virtualMachineConfiguration	プールの仮想マシン構成。 このプロパティと cloudServiceConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。
vmSize	プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 Cloud Services プール (cloudServiceConfiguration で作成されたプール) で使用可能な仮想マシンのサイズについては、「Cloud Services のサイズ (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/)」を参照してください。 Batch では、ExtraSmall、A1V2、A2V2 を除くすべての Cloud Services VM サイズがサポートされます。 Virtual Machines Marketplace のイメージを使用するプールで使用可能な VM サイズ (virtualMachineConfiguration で作成されたプール) の詳細については、「仮想マシンのサイズ (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) または仮想マシンのサイズ (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。

プロパティの詳細

applicationLicenses

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

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 サービスは詳細なエラー情報を含む要求を拒否します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする」(https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) を参照してください。

autoScaleFormula?: string

プロパティ値

string

certificateReferences

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

certificateReferences?: CertificateReference[]

プロパティ値

CertificateReference[]

cloudServiceConfiguration

プールのクラウド サービス構成。 このプロパティと virtualMachineConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。 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

id

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

id: string

プロパティ値

string

metadata

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

metadata?: MetadataItem[]

プロパティ値

MetadataItem[]

mountConfiguration

プールの有効期間全体にわたって、指定されたファイル システムを使用して記憶域をマウントします。 Azure ファイル共有、NFS、CIFS、または 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

プールの仮想マシン構成。 このプロパティと cloudServiceConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。

virtualMachineConfiguration?: VirtualMachineConfiguration

プロパティ値

VirtualMachineConfiguration

vmSize

プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 Cloud Services プール (cloudServiceConfiguration で作成されたプール) で使用可能な仮想マシンのサイズについては、「Cloud Services のサイズ (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/)」を参照してください。 Batch では、ExtraSmall、A1V2、A2V2 を除くすべての Cloud Services VM サイズがサポートされます。 Virtual Machines Marketplace のイメージを使用するプールで使用可能な VM サイズ (virtualMachineConfiguration で作成されたプール) の詳細については、「仮想マシンのサイズ (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) または仮想マシンのサイズ (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。

vmSize: string

プロパティ値

string