BatchPool interface

套件:

@azure/batch

A Pool in the Azure Batch service.

屬性

allocationState	集區是否重設大小。
allocationStateTransitionTime	集區進入其目前配置狀態的時間。
applicationPackageReferences	要安裝在集區中每個計算節點上的套件清單。 封裝參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新映射為止。 任何指定的集區上最多有10個套件參考。
autoScaleEvaluationInterval	根據自動調整公式自動調整集區大小的時間間隔。 只有當集區自動調整時，才會設定此屬性，也就是 enableAutoScale 為 true。 時間長度以ISO 8601格式規定。
autoScaleFormula	集區中所需計算節點數目的公式。 只有當集區自動調整時，才會設定此屬性，也就是 enableAutoScale 為 true。
autoScaleRun	自動調整公式上次執行的結果和錯誤。 只有當集區自動調整時，才會設定此屬性，也就是 enableAutoScale 為 true。
creationTime	集區的建立時間。
currentDedicatedNodes	集區中目前專用計算節點的數目。
currentLowPriorityNodes	目前位於集區中的現成/低優先順序計算節點數目。 已先佔的現成/低優先順序計算節點會包含在此計數中。
displayName	顯示名稱不是唯一的，而且可以包含最大長度為 1024 的任何 Unicode 字元。
enableAutoScale	集區大小是否應該隨著時間自動調整。 如果為 false，則必須指定至少一個 targetDedicatedNodes 和 targetLowPriorityNodes。 如果為 true，則需要 autoScaleFormula 屬性，而且集區會根據公式自動重設大小。 預設值為 false。
enableInterNodeCommunication	集區是否允許計算節點之間的直接通訊。 啟用節點間通訊會限制集區的大小上限，因為集區的計算節點有部署限制。 這可能會導致集區無法達到其所需的大小。 預設值為 false。
eTag	集區的 ETag。 這是不透明的字串。 您可以使用它來偵測集區是否已在要求之間變更。 特別是，您可以在更新集區時傳遞ETag，以指定只有當其他人同時沒有修改集區時，您的變更才會生效。
id	可唯一識別帳戶內集區的字串。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。 標識符是區分大小寫和不區分大小寫的（也就是說，您可能不會在帳戶內有兩個標識符，只有大小寫不同）。
identity	如果已設定，則為 Batch 集區的身分識別。 與 Batch 集區相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
lastModified	集區上次修改的時間。 這是集區層級數據上次變更的時間，例如 targetDedicatedNodes 或 enableAutoscale 設定。 它不會考慮節點層級變更，例如計算節點變更狀態。
metadata	與集區相關聯的名稱/值組清單做為元數據。
mountConfiguration	在集區的整個存留期內，使用指定的檔案系統掛接記憶體。 使用Azure檔案共享、NFS、CIFS或Blobfuse檔案系統掛載儲存裝置。
networkConfiguration	集區的網路組態。
poolStatistics	集區整個存留期的使用率和資源使用量統計數據。 只有在使用包含 『stats』 屬性的 expand 子句擷取 BatchPool 時，才會填入此屬性;否則為 null。 統計數據可能無法立即取得。 Batch 服務會定期匯總統計數據。 一般延遲約30分鐘。
resizeErrors	執行集區上最後一次重設大小時遇到的錯誤清單。 只有當上次集區重設大小期間發生一或多個錯誤，而且只有在PoolallocationState為穩定時，才會設定此屬性。
resizeTimeout	將計算節點配置至集區的逾時。 這是最近重設大小作業的逾時。 （建立集區時的初始重設大小會計算為重設大小。預設值為15分鐘。 時間長度以ISO 8601格式規定。
startTask	在聯結集區時，指定要在每個計算節點上執行的工作。
state	集區的目前狀態。
stateTransitionTime	集區進入其目前狀態的時間。
targetDedicatedNodes	集區中所需的專用計算節點數目。
targetLowPriorityNodes	集區中所需的現成/低優先順序計算節點數目。
taskSchedulingPolicy	工作如何分散到集區中的計算節點。 如果未指定，則會散佈預設值。
taskSlotsPerNode	可用於在集區中單一計算節點上執行並行工作的工作位置數目。 預設值是 1。 最大值是集區 vmSize 或 256 核心數目的 4 倍小。
upgradePolicy	集區的升級原則。 描述升級原則 - 自動、手動或滾動。
url	集區的 URL。
userAccounts	要建立於集區中每個計算節點上的用戶帳戶清單。
virtualMachineConfiguration	集區的虛擬機組態。 您必須指定這個屬性。
vmSize	集區中的虛擬機大小。 集區中的所有虛擬機大小都相同。 關於池中虛擬機可用大小的資訊，請參見「選擇Azure Batch池中運算節點的虛擬機大小（https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes）。

屬性詳細資料

allocationState

集區是否重設大小。

allocationState?: AllocationState

屬性值

AllocationState

allocationStateTransitionTime

集區進入其目前配置狀態的時間。

allocationStateTransitionTime?: Date

屬性值

Date

applicationPackageReferences

要安裝在集區中每個計算節點上的套件清單。 封裝參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新映射為止。 任何指定的集區上最多有10個套件參考。

applicationPackageReferences?: BatchApplicationPackageReference[]

屬性值

BatchApplicationPackageReference[]

autoScaleEvaluationInterval

根據自動調整公式自動調整集區大小的時間間隔。 只有當集區自動調整時，才會設定此屬性，也就是 enableAutoScale 為 true。 時間長度以ISO 8601格式規定。

autoScaleEvaluationInterval?: string

屬性值

string

autoScaleFormula

集區中所需計算節點數目的公式。 只有當集區自動調整時，才會設定此屬性，也就是 enableAutoScale 為 true。

autoScaleFormula?: string

屬性值

string

autoScaleRun

自動調整公式上次執行的結果和錯誤。 只有當集區自動調整時，才會設定此屬性，也就是 enableAutoScale 為 true。

autoScaleRun?: AutoScaleRun

屬性值

AutoScaleRun

creationTime

集區的建立時間。

creationTime: Date

屬性值

Date

currentDedicatedNodes

集區中目前專用計算節點的數目。

currentDedicatedNodes: number

屬性值

number

currentLowPriorityNodes

目前位於集區中的現成/低優先順序計算節點數目。 已先佔的現成/低優先順序計算節點會包含在此計數中。

currentLowPriorityNodes: number

屬性值

number

displayName

顯示名稱不是唯一的，而且可以包含最大長度為 1024 的任何 Unicode 字元。

displayName?: string

屬性值

string

enableAutoScale

集區大小是否應該隨著時間自動調整。 如果為 false，則必須指定至少一個 targetDedicatedNodes 和 targetLowPriorityNodes。 如果為 true，則需要 autoScaleFormula 屬性，而且集區會根據公式自動重設大小。 預設值為 false。

enableAutoScale?: boolean

屬性值

boolean

enableInterNodeCommunication

集區是否允許計算節點之間的直接通訊。 啟用節點間通訊會限制集區的大小上限，因為集區的計算節點有部署限制。 這可能會導致集區無法達到其所需的大小。 預設值為 false。

enableInterNodeCommunication?: boolean

屬性值

boolean

eTag

集區的 ETag。 這是不透明的字串。 您可以使用它來偵測集區是否已在要求之間變更。 特別是，您可以在更新集區時傳遞ETag，以指定只有當其他人同時沒有修改集區時，您的變更才會生效。

eTag: string

屬性值

string

id

可唯一識別帳戶內集區的字串。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。 標識符是區分大小寫和不區分大小寫的（也就是說，您可能不會在帳戶內有兩個標識符，只有大小寫不同）。

id: string

屬性值

string

identity

如果已設定，則為 Batch 集區的身分識別。 與 Batch 集區相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

identity?: BatchPoolIdentity

屬性值

BatchPoolIdentity

lastModified

集區上次修改的時間。 這是集區層級數據上次變更的時間，例如 targetDedicatedNodes 或 enableAutoscale 設定。 它不會考慮節點層級變更，例如計算節點變更狀態。

lastModified: Date

屬性值

Date

metadata

與集區相關聯的名稱/值組清單做為元數據。

metadata?: BatchMetadataItem[]

屬性值

BatchMetadataItem[]

mountConfiguration

在集區的整個存留期內，使用指定的檔案系統掛接記憶體。 使用Azure檔案共享、NFS、CIFS或Blobfuse檔案系統掛載儲存裝置。

mountConfiguration?: MountConfiguration[]

屬性值

MountConfiguration[]

networkConfiguration

集區的網路組態。

networkConfiguration?: NetworkConfiguration

屬性值

NetworkConfiguration

poolStatistics

集區整個存留期的使用率和資源使用量統計數據。 只有在使用包含 『stats』 屬性的 expand 子句擷取 BatchPool 時，才會填入此屬性;否則為 null。 統計數據可能無法立即取得。 Batch 服務會定期匯總統計數據。 一般延遲約30分鐘。

poolStatistics?: BatchPoolStatistics

屬性值

BatchPoolStatistics

resizeErrors

執行集區上最後一次重設大小時遇到的錯誤清單。 只有當上次集區重設大小期間發生一或多個錯誤，而且只有在PoolallocationState為穩定時，才會設定此屬性。

resizeErrors?: ResizeError[]

屬性值

ResizeError[]

resizeTimeout

將計算節點配置至集區的逾時。 這是最近重設大小作業的逾時。 （建立集區時的初始重設大小會計算為重設大小。預設值為15分鐘。 時間長度以ISO 8601格式規定。

resizeTimeout?: string

屬性值

string

startTask

在聯結集區時，指定要在每個計算節點上執行的工作。

startTask?: BatchStartTask

屬性值

BatchStartTask

state

集區的目前狀態。

state: BatchPoolState

屬性值

BatchPoolState

stateTransitionTime

集區進入其目前狀態的時間。

stateTransitionTime: Date

屬性值

Date

targetDedicatedNodes

集區中所需的專用計算節點數目。

targetDedicatedNodes?: number

屬性值

number

targetLowPriorityNodes

集區中所需的現成/低優先順序計算節點數目。

targetLowPriorityNodes?: number

屬性值

number

taskSchedulingPolicy

工作如何分散到集區中的計算節點。 如果未指定，則會散佈預設值。

taskSchedulingPolicy?: BatchTaskSchedulingPolicy

屬性值

BatchTaskSchedulingPolicy

taskSlotsPerNode

可用於在集區中單一計算節點上執行並行工作的工作位置數目。 預設值是 1。 最大值是集區 vmSize 或 256 核心數目的 4 倍小。

taskSlotsPerNode?: number

屬性值

number

upgradePolicy

集區的升級原則。 描述升級原則 - 自動、手動或滾動。

upgradePolicy?: UpgradePolicy

屬性值

UpgradePolicy

url

集區的 URL。

url: string

屬性值

string

userAccounts

要建立於集區中每個計算節點上的用戶帳戶清單。

userAccounts?: UserAccount[]

屬性值

UserAccount[]

virtualMachineConfiguration

集區的虛擬機組態。 您必須指定這個屬性。

virtualMachineConfiguration?: VirtualMachineConfiguration

屬性值

VirtualMachineConfiguration

vmSize

集區中的虛擬機大小。 集區中的所有虛擬機大小都相同。 關於池中虛擬機可用大小的資訊，請參見「選擇Azure Batch池中運算節點的虛擬機大小（https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes）。

vmSize: string

屬性值

string