次の方法で共有

Pool interface

  • リファレンス
パッケージ:
@azure/arm-batch

プールに関する情報が含まれます。

Extends
ProxyResource

プロパティ

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

CloudServiceConfiguration を使用すると、ノードは Azure Cloud Services (PaaS) を使用して作成する必要があり、VirtualMachineConfiguration では Azure Virtual Machines (IaaS) が使用されます。
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' のいずれかになります。 このプロパティを指定しない場合、プールには targetDedicatedNodes が 0 の固定スケールが設定されます。
startTask

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

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

指定しない場合、既定値はスプレッドになります。
taskSlotsPerNode

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

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

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

Cloud Services プール (cloudServiceConfiguration を使用して作成されたプール) で使用可能な仮想マシンのサイズについては、「Cloud Servicesのサイズ (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/)」を参照してください。 Batch では、ExtraSmall を除くすべてのCloud Services VM サイズがサポートされます。 Virtual Machines Marketplace のイメージを使用するプール (virtualMachineConfiguration を使用して作成されたプール) で使用可能な VM サイズの詳細については、「Virtual Machinesのサイズ (Linux)(https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)」または「Virtual Machinesのサイズ (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

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

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

プロパティの詳細

allocationState

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

allocationState?: AllocationState

プロパティ値

AllocationState

allocationStateTransitionTime

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

allocationStateTransitionTime?: Date

プロパティ値

Date

applicationLicenses

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

applicationLicenses?: string[]

プロパティ値

string[]

applicationPackages

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

applicationPackages?: ApplicationPackageReference[]

プロパティ値

ApplicationPackageReference[]

autoScaleRun

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

autoScaleRun?: AutoScaleRun

プロパティ値

AutoScaleRun

certificates

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

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

certificates?: CertificateReference[]

プロパティ値

CertificateReference[]

creationTime

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

creationTime?: Date

プロパティ値

Date

currentDedicatedNodes

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

currentDedicatedNodes?: number

プロパティ値

number

currentLowPriorityNodes

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

currentLowPriorityNodes?: number

プロパティ値

number

currentNodeCommunicationMode

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

currentNodeCommunicationMode?: NodeCommunicationMode

プロパティ値

NodeCommunicationMode

deploymentConfiguration

CloudServiceConfiguration を使用すると、ノードは Azure Cloud Services (PaaS) を使用して作成する必要があり、VirtualMachineConfiguration では Azure Virtual Machines (IaaS) が使用されます。

deploymentConfiguration?: DeploymentConfiguration

プロパティ値

DeploymentConfiguration

displayName

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

displayName?: string

プロパティ値

string

identity

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

identity?: BatchPoolIdentity

プロパティ値

BatchPoolIdentity

interNodeCommunication

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

interNodeCommunication?: InterNodeCommunicationState

プロパティ値

InterNodeCommunicationState

lastModified

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

lastModified?: Date

プロパティ値

Date

metadata

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

metadata?: MetadataItem[]

プロパティ値

MetadataItem[]

mountConfiguration

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

mountConfiguration?: MountConfiguration[]

プロパティ値

MountConfiguration[]

networkConfiguration

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

networkConfiguration?: NetworkConfiguration

プロパティ値

NetworkConfiguration

provisioningState

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

provisioningState?: PoolProvisioningState

プロパティ値

PoolProvisioningState

provisioningStateTransitionTime

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

provisioningStateTransitionTime?: Date

プロパティ値

Date

resizeOperationStatus

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

resizeOperationStatus?: ResizeOperationStatus

プロパティ値

ResizeOperationStatus

resourceTags

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

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

プロパティ値

{[propertyName: string]: string}

scaleSettings

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

scaleSettings?: ScaleSettings

プロパティ値

ScaleSettings

startTask

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

startTask?: StartTask

プロパティ値

StartTask

targetNodeCommunicationMode

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

targetNodeCommunicationMode?: NodeCommunicationMode

プロパティ値

NodeCommunicationMode

taskSchedulingPolicy

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

taskSchedulingPolicy?: TaskSchedulingPolicy

プロパティ値

TaskSchedulingPolicy

taskSlotsPerNode

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

taskSlotsPerNode?: number

プロパティ値

number

upgradePolicy

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

upgradePolicy?: UpgradePolicy

プロパティ値

UpgradePolicy

userAccounts

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

userAccounts?: UserAccount[]

プロパティ値

UserAccount[]

vmSize

Cloud Services プール (cloudServiceConfiguration を使用して作成されたプール) で使用可能な仮想マシンのサイズについては、「Cloud Servicesのサイズ (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/)」を参照してください。 Batch では、ExtraSmall を除くすべてのCloud Services VM サイズがサポートされます。 Virtual Machines Marketplace のイメージを使用するプール (virtualMachineConfiguration を使用して作成されたプール) で使用可能な VM サイズの詳細については、「Virtual Machinesのサイズ (Linux)(https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)」または「Virtual Machinesのサイズ (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

ProxyResource.etagから継承

id

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

id?: string

プロパティ値

string

ProxyResource.id から継承

name

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

name?: string

プロパティ値

string

ProxyResource.name から継承

type

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

type?: string

プロパティ値

string

ProxyResource.typeから継承