CloudPool interface

パッケージ:

@azure/batch

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

プロパティ

allocationState	プールのサイズが変更されているかどうか。 使用可能な値は、"steady"、"サイズ変更中"、"停止中" です。
allocationStateTransitionTime	プールが現在の割り当て状態になった時刻。
applicationLicenses	Batch サービスがプール内の各コンピューティング ノードで使用できるアプリケーション ライセンスの一覧。 アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。
applicationPackageReferences	プール内の各コンピューティング ノードにインストールするパッケージの一覧。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。
autoScaleEvaluationInterval	自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 このプロパティは、プールが自動的にスケーリングされる場合 (enableAutoScale が true の場合) にのみ設定されます。
autoScaleFormula	プール内のコンピューティング ノードの必要な数の数式。 このプロパティは、プールが自動的にスケーリングされる場合 (enableAutoScale が true の場合) にのみ設定されます。
autoScaleRun	自動スケール式の最後の実行の結果とエラー。 このプロパティは、プールが自動的にスケーリングされる場合 (enableAutoScale が true の場合) にのみ設定されます。
certificateReferences	プール内の各コンピューティング ノードにインストールする証明書の一覧。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。
cloudServiceConfiguration	プールのクラウド サービス構成。 このプロパティと virtualMachineConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合、このプロパティを指定できません。
creationTime	プールの作成時刻。
currentDedicatedNodes	プール内の現在の専用コンピューティング ノードの数。
currentLowPriorityNodes	現在プール内にある優先順位の低いコンピューティング ノードの数。 このカウントには、割り込まれた優先順位の低いコンピューティング ノードが含まれます。
displayName	プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
enableAutoScale	プール サイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合、targetDedicateNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合、autoScaleFormula プロパティが必要であり、プールは数式に従って自動的にサイズ変更されます。 既定値は false です。
enableInterNodeCommunication	プールがコンピューティング ノード間の直接通信を許可するかどうか。 これにより、プールに割り当てることができるコンピューティング ノードに制限が適用されます。 この値を指定すると、要求されたコンピューティング ノードの数がプールに割り当てられる可能性が低くなります。
eTag	プールの ETag。 これは不透明な文字列です。 これを使用して、要求間でプールが変更されたかどうかを検出できます。 特に、プールを更新するときに ETag を渡して、その間に他の誰もプールを変更していない場合にのみ変更を有効にするように指定できます。
id	アカウント内のプールを一意に識別する文字列。 ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なる 2 つの ID がない可能性があります)。
lastModified	プールの最終変更時刻。 これは、targetDedicatedNodes や enableAutoscale 設定など、プール レベルのデータが最後に変更された時刻です。 コンピューティング ノードの状態の変化など、ノード レベルの変更は考慮されません。
metadata	メタデータとしてプールに関連付けられている名前と値のペアの一覧。
mountConfiguration	プール内の各ノードにマウントするファイル システムの一覧。 これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
networkConfiguration	プールのネットワーク構成。
resizeErrors	プールで最後のサイズ変更の実行中に発生したエラーの一覧。 このプロパティは、プールの最後のサイズ変更中に 1 つ以上のエラーが発生した場合にのみ設定され、プールの割り当て状態が安定している場合にのみ設定されます。
resizeTimeout	プールへのコンピューティング ノードの割り当てのタイムアウト。 これは、最新のサイズ変更操作のタイムアウトです。 (プールの作成時の初期サイズ変更はサイズ変更としてカウントされます)。既定値は 15 分です。
startTask	プールに参加する各コンピューティング ノードで実行するように指定されたタスク。
state	プールの現在の状態。 使用可能な値は、'active'、'deleting' です。
stateTransitionTime	プールが現在の状態になった時刻。
stats	プールの有効期間全体の使用率とリソース使用状況の統計情報。 このプロパティは、CloudPool が 'stats' 属性を含む expand 句で取得された場合にのみ設定されます。それ以外の場合は null です。 統計をすぐに使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。
targetDedicatedNodes	プール内の専用コンピューティング ノードの必要な数。
targetLowPriorityNodes	プール内の優先順位の低いコンピューティング ノードの必要な数。
taskSchedulingPolicy	プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。
taskSlotsPerNode	プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
url	プールの URL。
userAccounts	プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。
virtualMachineConfiguration	プールの仮想マシン構成。 このプロパティと cloudServiceConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。
vmSize	プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 プールで使用可能な仮想マシンのサイズについては、「Azure Batch プールのコンピューティング ノードの VM サイズの選択 (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。

プロパティの詳細

allocationState

プールのサイズが変更されているかどうか。 使用可能な値は、"steady"、"サイズ変更中"、"停止中" です。

allocationState?: AllocationState

プロパティ値

AllocationState

allocationStateTransitionTime

プールが現在の割り当て状態になった時刻。

allocationStateTransitionTime?: Date

プロパティ値

Date

applicationLicenses

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

applicationLicenses?: string[]

プロパティ値

string[]

applicationPackageReferences

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

applicationPackageReferences?: ApplicationPackageReference[]

プロパティ値

ApplicationPackageReference[]

autoScaleEvaluationInterval

自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 このプロパティは、プールが自動的にスケーリングされる場合 (enableAutoScale が true の場合) にのみ設定されます。

autoScaleEvaluationInterval?: string

プロパティ値

string

autoScaleFormula

プール内のコンピューティング ノードの必要な数の数式。 このプロパティは、プールが自動的にスケーリングされる場合 (enableAutoScale が true の場合) にのみ設定されます。

autoScaleFormula?: string

プロパティ値

string

autoScaleRun

自動スケール式の最後の実行の結果とエラー。 このプロパティは、プールが自動的にスケーリングされる場合 (enableAutoScale が true の場合) にのみ設定されます。

autoScaleRun?: AutoScaleRun

プロパティ値

AutoScaleRun

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

creationTime

プールの作成時刻。

creationTime?: Date

プロパティ値

Date

currentDedicatedNodes

プール内の現在の専用コンピューティング ノードの数。

currentDedicatedNodes?: number

プロパティ値

number

currentLowPriorityNodes

現在プール内にある優先順位の低いコンピューティング ノードの数。 このカウントには、割り込まれた優先順位の低いコンピューティング ノードが含まれます。

currentLowPriorityNodes?: number

プロパティ値

number

displayName

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

displayName?: string

プロパティ値

string

enableAutoScale

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

enableAutoScale?: boolean

プロパティ値

boolean

enableInterNodeCommunication

プールがコンピューティング ノード間の直接通信を許可するかどうか。 これにより、プールに割り当てることができるコンピューティング ノードに制限が適用されます。 この値を指定すると、要求されたコンピューティング ノードの数がプールに割り当てられる可能性が低くなります。

enableInterNodeCommunication?: boolean

プロパティ値

boolean

eTag

プールの ETag。 これは不透明な文字列です。 これを使用して、要求間でプールが変更されたかどうかを検出できます。 特に、プールを更新するときに ETag を渡して、その間に他の誰もプールを変更していない場合にのみ変更を有効にするように指定できます。

eTag?: string

プロパティ値

string

id

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

id?: string

プロパティ値

string

lastModified

プールの最終変更時刻。 これは、targetDedicatedNodes や enableAutoscale 設定など、プール レベルのデータが最後に変更された時刻です。 コンピューティング ノードの状態の変化など、ノード レベルの変更は考慮されません。

lastModified?: Date

プロパティ値

Date

metadata

メタデータとしてプールに関連付けられている名前と値のペアの一覧。

metadata?: MetadataItem[]

プロパティ値

MetadataItem[]

mountConfiguration

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

mountConfiguration?: MountConfiguration[]

プロパティ値

MountConfiguration[]

networkConfiguration

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

networkConfiguration?: NetworkConfiguration

プロパティ値

NetworkConfiguration

resizeErrors

プールで最後のサイズ変更の実行中に発生したエラーの一覧。 このプロパティは、プールの最後のサイズ変更中に 1 つ以上のエラーが発生した場合にのみ設定され、プールの割り当て状態が安定している場合にのみ設定されます。

resizeErrors?: ResizeError[]

プロパティ値

ResizeError[]

resizeTimeout

プールへのコンピューティング ノードの割り当てのタイムアウト。 これは、最新のサイズ変更操作のタイムアウトです。 (プールの作成時の初期サイズ変更はサイズ変更としてカウントされます)。既定値は 15 分です。

resizeTimeout?: string

プロパティ値

string

startTask

プールに参加する各コンピューティング ノードで実行するように指定されたタスク。

startTask?: StartTask

プロパティ値

StartTask

state

プールの現在の状態。 使用可能な値は、'active'、'deleting' です。

state?: PoolState

プロパティ値

PoolState

stateTransitionTime

プールが現在の状態になった時刻。

stateTransitionTime?: Date

プロパティ値

Date

stats

プールの有効期間全体の使用率とリソース使用状況の統計情報。 このプロパティは、CloudPool が 'stats' 属性を含む expand 句で取得された場合にのみ設定されます。それ以外の場合は null です。 統計をすぐに使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。

stats?: PoolStatistics

プロパティ値

PoolStatistics

targetDedicatedNodes

プール内の専用コンピューティング ノードの必要な数。

targetDedicatedNodes?: number

プロパティ値

number

targetLowPriorityNodes

プール内の優先順位の低いコンピューティング ノードの必要な数。

targetLowPriorityNodes?: number

プロパティ値

number

taskSchedulingPolicy

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

taskSchedulingPolicy?: TaskSchedulingPolicy

プロパティ値

TaskSchedulingPolicy

taskSlotsPerNode

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

taskSlotsPerNode?: number

プロパティ値

number

url

プールの URL。

url?: string

プロパティ値

string

userAccounts

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

userAccounts?: UserAccount[]

プロパティ値

UserAccount[]

virtualMachineConfiguration

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

virtualMachineConfiguration?: VirtualMachineConfiguration

プロパティ値

VirtualMachineConfiguration

vmSize

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

vmSize?: string

プロパティ値

string