次の方法で共有


Pool interface

プールに関する情報を格納します。

Extends

プロパティ

allocationState

プールのサイズが変更されているかどうか。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

allocationStateTransitionTime

プールが現在の割り当て状態になった時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

applicationLicenses

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

applicationPackages

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

autoScaleRun

このプロパティは、プールが自動的にスケーリングされる場合 、つまり autoScaleSettings が使用される場合にのみ設定されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

certificates

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

警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに、Azure KeyVault 拡張機能 を使用してください。

creationTime

プールの作成時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

currentDedicatedNodes

プール内の現在の専用コンピューティング ノードの数。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

currentLowPriorityNodes

プール内の現在のスポット/優先順位の低いコンピューティング ノードの数。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

currentNodeCommunicationMode

プールが Batch サービスと通信する方法を決定します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

deploymentConfiguration

展開構成プロパティ。

displayName

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

identity

バッチ プールに使用される ID の種類。

interNodeCommunication

これにより、プールに割り当てることができるノードに制限が適用されます。 この値を有効にすると、要求されたノード数がプールに割り当てられる可能性が低くなります。 指定しない場合、この値の既定値は "Disabled" になります。

lastModified

これは、targetDedicatedNodes や autoScaleSettings などのプール レベルのデータが最後に変更された時刻です。 コンピューティング ノードの状態の変化など、ノード レベルの変更は考慮されません。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

metadata

Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。

mountConfiguration

これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。

networkConfiguration

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

provisioningState

プールの現在の状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

provisioningStateTransitionTime

プールが現在の状態になった時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

resizeOperationStatus

現在の操作 (プール AllocationState がサイズ変更中の場合) または以前に完了した操作 (AllocationState が安定している場合) について説明します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

resourceTags

Azure Batch プールに関連付けるユーザー定義タグ。 これらのタグを指定すると、プールに関連付けられているバッキング Azure リソースにこれらのタグが伝達されます。 このプロパティは、poolAllocationMode プロパティが 'UserSubscription' に設定された Batch アカウントが作成された場合にのみ指定できます。

scaleSettings

プールの目的のサイズを定義します。 これは、要求された targetDedicatedNodes が指定されている "fixedScale" か、定期的に再評価される数式を定義する 'autoScale' のいずれかです。 このプロパティを指定しない場合、プールは 0 targetDedicatedNodes を使用して固定スケールになります。

startTask

PATCH (更新) 操作では、このプロパティを空のオブジェクトに設定して、プールから開始タスクを削除できます。

targetNodeCommunicationMode

省略した場合、既定値は Default です。

taskSchedulingPolicy

指定しない場合、既定値はスプレッドです。

taskSlotsPerNode

既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。

upgradePolicy

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

userAccounts

プール内の各ノードに作成するユーザー アカウントの一覧。

vmSize

使用可能な VM サイズの詳細については、「仮想マシンのサイズ (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 サイズがサポートされます。

継承されたプロパティ

etag

コンカレンシー ステートメントに使用されるリソースの ETag。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id

リソースの ID。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name

リソースの名前。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

tags

リソースのタグ。

type

リソースの型。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

allocationState

プールのサイズが変更されているかどうか。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

allocationState?: AllocationState

プロパティ値

allocationStateTransitionTime

プールが現在の割り当て状態になった時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

allocationStateTransitionTime?: Date

プロパティ値

Date

applicationLicenses

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

applicationLicenses?: string[]

プロパティ値

string[]

applicationPackages

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

applicationPackages?: ApplicationPackageReference[]

プロパティ値

autoScaleRun

このプロパティは、プールが自動的にスケーリングされる場合 、つまり autoScaleSettings が使用される場合にのみ設定されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

autoScaleRun?: AutoScaleRun

プロパティ値

certificates

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

警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに、Azure KeyVault 拡張機能 を使用してください。

certificates?: CertificateReference[]

プロパティ値

creationTime

プールの作成時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

creationTime?: Date

プロパティ値

Date

currentDedicatedNodes

プール内の現在の専用コンピューティング ノードの数。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

currentDedicatedNodes?: number

プロパティ値

number

currentLowPriorityNodes

プール内の現在のスポット/優先順位の低いコンピューティング ノードの数。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

currentLowPriorityNodes?: number

プロパティ値

number

currentNodeCommunicationMode

プールが Batch サービスと通信する方法を決定します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

currentNodeCommunicationMode?: NodeCommunicationMode

プロパティ値

deploymentConfiguration

展開構成プロパティ。

deploymentConfiguration?: DeploymentConfiguration

プロパティ値

displayName

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

displayName?: string

プロパティ値

string

identity

バッチ プールに使用される ID の種類。

identity?: BatchPoolIdentity

プロパティ値

interNodeCommunication

これにより、プールに割り当てることができるノードに制限が適用されます。 この値を有効にすると、要求されたノード数がプールに割り当てられる可能性が低くなります。 指定しない場合、この値の既定値は "Disabled" になります。

interNodeCommunication?: InterNodeCommunicationState

プロパティ値

lastModified

これは、targetDedicatedNodes や autoScaleSettings などのプール レベルのデータが最後に変更された時刻です。 コンピューティング ノードの状態の変化など、ノード レベルの変更は考慮されません。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

lastModified?: Date

プロパティ値

Date

metadata

Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。

metadata?: MetadataItem[]

プロパティ値

mountConfiguration

これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。

mountConfiguration?: MountConfiguration[]

プロパティ値

networkConfiguration

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

networkConfiguration?: NetworkConfiguration

プロパティ値

provisioningState

プールの現在の状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

provisioningState?: PoolProvisioningState

プロパティ値

provisioningStateTransitionTime

プールが現在の状態になった時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

provisioningStateTransitionTime?: Date

プロパティ値

Date

resizeOperationStatus

現在の操作 (プール AllocationState がサイズ変更中の場合) または以前に完了した操作 (AllocationState が安定している場合) について説明します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

resizeOperationStatus?: ResizeOperationStatus

プロパティ値

resourceTags

Azure Batch プールに関連付けるユーザー定義タグ。 これらのタグを指定すると、プールに関連付けられているバッキング Azure リソースにこれらのタグが伝達されます。 このプロパティは、poolAllocationMode プロパティが 'UserSubscription' に設定された Batch アカウントが作成された場合にのみ指定できます。

resourceTags?: {[propertyName: string]: string}

プロパティ値

{[propertyName: string]: string}

scaleSettings

プールの目的のサイズを定義します。 これは、要求された targetDedicatedNodes が指定されている "fixedScale" か、定期的に再評価される数式を定義する 'autoScale' のいずれかです。 このプロパティを指定しない場合、プールは 0 targetDedicatedNodes を使用して固定スケールになります。

scaleSettings?: ScaleSettings

プロパティ値

startTask

PATCH (更新) 操作では、このプロパティを空のオブジェクトに設定して、プールから開始タスクを削除できます。

startTask?: StartTask

プロパティ値

targetNodeCommunicationMode

省略した場合、既定値は Default です。

targetNodeCommunicationMode?: NodeCommunicationMode

プロパティ値

taskSchedulingPolicy

指定しない場合、既定値はスプレッドです。

taskSchedulingPolicy?: TaskSchedulingPolicy

プロパティ値

taskSlotsPerNode

既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。

taskSlotsPerNode?: number

プロパティ値

number

upgradePolicy

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

upgradePolicy?: UpgradePolicy

プロパティ値

userAccounts

プール内の各ノードに作成するユーザー アカウントの一覧。

userAccounts?: UserAccount[]

プロパティ値

vmSize

使用可能な VM サイズの詳細については、「仮想マシンのサイズ (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

継承されたプロパティの詳細

etag

コンカレンシー ステートメントに使用されるリソースの ETag。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

etag?: string

プロパティ値

string

承元AzureProxyResource.etag

id

リソースの ID。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id?: string

プロパティ値

string

承元AzureProxyResource.id

name

リソースの名前。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name?: string

プロパティ値

string

承元AzureProxyResource.name

tags

リソースのタグ。

tags?: {[propertyName: string]: string}

プロパティ値

{[propertyName: string]: string}

承元:AzureProxyResource.tags

type

リソースの型。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

type?: string

プロパティ値

string

承元AzureProxyResource.type