BatchPoolSpecification interface

套件:

@azure/batch

建立新集區的規格。

屬性

applicationPackageReferences	要安裝在集區中每個計算節點上的套件清單。 建立池時，套件的應用程式 ID 必須完全限定（/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft。Batch/batchAccounts/{accountName}/applications/{applicationName}）。 封裝參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新映射為止。 任何指定的集區上最多有10個套件參考。
autoScaleEvaluationInterval	根據自動調整公式自動調整集區大小的時間間隔。 預設值為15分鐘。 最小值和最大值分別為 5 分鐘和 168 小時。 如果您指定的值小於 5 分鐘或大於 168 小時，Batch 服務會拒絕要求，且屬性值錯誤無效;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 時間長度以ISO 8601格式規定。
autoScaleFormula	集區中所需計算節點數目的公式。 如果 enableAutoScale 設定為 false，則不得指定此屬性。 如果 enableAutoScale 設定為 true，則為必要專案。 在建立集區之前，會先檢查公式是否有效。 如果公式無效，Batch 服務會以詳細的錯誤資訊拒絕要求。
displayName	集區的顯示名稱。 顯示名稱不是唯一的，而且可以包含最大長度為 1024 的任何 Unicode 字元。
enableAutoScale	集區大小是否應該隨著時間自動調整。 如果為 false，則必須指定至少一個 targetDedicatedNodes 和 targetLowPriorityNodes。 如果為 true，則需要 autoScaleFormula 元素。 集區會根據公式自動重設大小。 預設值為 false。
enableInterNodeCommunication	集區是否允許計算節點之間的直接通訊。 啟用節點間通訊會限制集區的大小上限，因為集區的計算節點有部署限制。 這可能會導致集區無法達到其所需的大小。 預設值為 false。
metadata	與集區相關聯的名稱/值組清單做為元數據。 Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。
mountConfiguration	要掛接在集區中每個節點上的檔案系統清單。 這支援 Azure 檔案儲存體、NFS、CIFS/SMB 以及 Blobfuse。
networkConfiguration	集區的網路組態。
resizeTimeout	將計算節點配置至集區的逾時。 此逾時僅適用於手動調整;當 enableAutoScale 設定為 true 時，它沒有任何作用。 預設值為15分鐘。 最小值為 5 分鐘。 如果您指定小於 5 分鐘的值，Batch 服務會拒絕要求併發生錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 時間長度以ISO 8601格式規定。
startTask	在聯結集區時，要在每個計算節點上執行的工作。 當計算節點新增至集區或計算節點重新啟動時，工作就會執行。
targetDedicatedNodes	集區中所需的專用計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。
targetLowPriorityNodes	集區中所需的現成/低優先順序計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。
taskSchedulingPolicy	工作如何分散到集區中的計算節點。 如果未指定，則會散佈預設值。
taskSlotsPerNode	可用於在集區中單一計算節點上執行並行工作的工作位置數目。 預設值是 1。 最大值是集區 vmSize 或 256 核心數目的 4 倍小。
upgradePolicy	集區的升級原則。 描述升級原則 - 自動、手動或滾動。
userAccounts	要建立於集區中每個計算節點上的用戶帳戶清單。
virtualMachineConfiguration	集區的虛擬機組態。 您必須指定這個屬性。
vmSize	集區中虛擬機的大小。 集區中的所有虛擬機大小都相同。 關於池中虛擬機可用大小的資訊，請參見「選擇Azure Batch池中運算節點的虛擬機大小（https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes）。

屬性詳細資料

applicationPackageReferences

要安裝在集區中每個計算節點上的套件清單。 建立池時，套件的應用程式 ID 必須完全限定（/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft。Batch/batchAccounts/{accountName}/applications/{applicationName}）。 封裝參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新映射為止。 任何指定的集區上最多有10個套件參考。

applicationPackageReferences?: BatchApplicationPackageReference[]

屬性值

BatchApplicationPackageReference[]

autoScaleEvaluationInterval

根據自動調整公式自動調整集區大小的時間間隔。 預設值為15分鐘。 最小值和最大值分別為 5 分鐘和 168 小時。 如果您指定的值小於 5 分鐘或大於 168 小時，Batch 服務會拒絕要求，且屬性值錯誤無效;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 時間長度以ISO 8601格式規定。

autoScaleEvaluationInterval?: string

屬性值

string

autoScaleFormula

集區中所需計算節點數目的公式。 如果 enableAutoScale 設定為 false，則不得指定此屬性。 如果 enableAutoScale 設定為 true，則為必要專案。 在建立集區之前，會先檢查公式是否有效。 如果公式無效，Batch 服務會以詳細的錯誤資訊拒絕要求。

autoScaleFormula?: string

屬性值

string

displayName

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

displayName?: string

屬性值

string

enableAutoScale

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

enableAutoScale?: boolean

屬性值

boolean

enableInterNodeCommunication

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

enableInterNodeCommunication?: boolean

屬性值

boolean

metadata

與集區相關聯的名稱/值組清單做為元數據。 Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。

metadata?: BatchMetadataItem[]

屬性值

BatchMetadataItem[]

mountConfiguration

要掛接在集區中每個節點上的檔案系統清單。 這支援 Azure 檔案儲存體、NFS、CIFS/SMB 以及 Blobfuse。

mountConfiguration?: MountConfiguration[]

屬性值

MountConfiguration[]

networkConfiguration

集區的網路組態。

networkConfiguration?: NetworkConfiguration

屬性值

NetworkConfiguration

resizeTimeout

將計算節點配置至集區的逾時。 此逾時僅適用於手動調整;當 enableAutoScale 設定為 true 時，它沒有任何作用。 預設值為15分鐘。 最小值為 5 分鐘。 如果您指定小於 5 分鐘的值，Batch 服務會拒絕要求併發生錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 時間長度以ISO 8601格式規定。

resizeTimeout?: string

屬性值

string

startTask

在聯結集區時，要在每個計算節點上執行的工作。 當計算節點新增至集區或計算節點重新啟動時，工作就會執行。

startTask?: BatchStartTask

屬性值

BatchStartTask

targetDedicatedNodes

集區中所需的專用計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。

targetDedicatedNodes?: number

屬性值

number

targetLowPriorityNodes

集區中所需的現成/低優先順序計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。

targetLowPriorityNodes?: number

屬性值

number

taskSchedulingPolicy

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

taskSchedulingPolicy?: BatchTaskSchedulingPolicy

屬性值

BatchTaskSchedulingPolicy

taskSlotsPerNode

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

taskSlotsPerNode?: number

屬性值

number

upgradePolicy

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

upgradePolicy?: UpgradePolicy

屬性值

UpgradePolicy

userAccounts

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

userAccounts?: UserAccount[]

屬性值

UserAccount[]

virtualMachineConfiguration

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

virtualMachineConfiguration?: VirtualMachineConfiguration

屬性值

VirtualMachineConfiguration

vmSize

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

vmSize: string

屬性值

string