PoolAddParameter interface

套件:

@azure/batch

代表 PoolAddParameter 的介面。

屬性

applicationLicenses	Batch 服務可在集區中的每個計算節點上取得應用程式授權清單。 應用程式授權清單必須是可用 Batch 服務應用程式授權的子集。 如果要求不支持的授權，集區建立將會失敗。
applicationPackageReferences	要安裝在集區中每個計算節點上的套件清單。 封裝參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新映射為止。 任何指定的集區上最多有10個套件參考。
autoScaleEvaluationInterval	根據自動調整公式自動調整集區大小的時間間隔。 預設值為15分鐘。 最小值和最大值分別為 5 分鐘和 168 小時。 如果您指定小於 5 分鐘或大於 168 小時的值，Batch 服務會傳回錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。
autoScaleFormula	集區中所需計算節點數目的公式。 如果 enableAutoScale 設定為 false，則不得指定此屬性。 如果 enableAutoScale 設定為 true，則為必要專案。 在建立集區之前，會先檢查公式是否有效。 如果公式無效，Batch 服務會以詳細的錯誤資訊拒絕要求。 如需指定此公式的詳細資訊，請參閱<自動調整 Azure Batch 集區中的計算節點>（）。
certificateReferences	要安裝在集區中每個計算節點上的憑證清單。 針對 Windows 節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs）和憑證放在該目錄中。
cloudServiceConfiguration	集區的雲端服務組態。 這個屬性和 virtualMachineConfiguration 互斥，而且必須指定其中一個屬性。 如果已建立 Batch 帳戶且其 poolAllocationMode 屬性設定為 'UserSubscription'，則無法指定此屬性。
displayName	集區的顯示名稱。 顯示名稱不是唯一的，而且可以包含最大長度為 1024 的任何 Unicode 字元。
enableAutoScale	集區大小是否應該隨著時間自動調整。 如果為 false，則必須指定至少一個 targetDedicateNodes 和 targetLowPriorityNodes。 如果為 true，則需要 autoScaleFormula 屬性，而且集區會根據公式自動重設大小。 默認值為 false。
enableInterNodeCommunication	集區是否允許計算節點之間的直接通訊。 啟用節點間通訊會限制集區的大小上限，因為集區的計算節點有部署限制。 這可能會導致集區無法達到其所需的大小。 默認值為 false。
id	可唯一識別帳戶內集區的字串。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。 標識符會保留大小寫且不區分大小寫（也就是說，您可能不會在帳戶內有兩個只區分大小寫的集區標識符）。
metadata	與集區相關聯的名稱/值組清單做為元數據。 Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。
mountConfiguration	在集區的整個存留期內，使用指定的檔案系統掛接記憶體。 使用 Azure 檔案共用、NFS、CIFS 或 Blobfuse 型文件系統掛接記憶體。
networkConfiguration	集區的網路組態。
resizeTimeout	將計算節點配置至集區的逾時。 此逾時僅適用於手動調整;當 enableAutoScale 設定為 true 時，它沒有任何作用。 預設值為15分鐘。 最小值為 5 分鐘。 如果您指定小於 5 分鐘的值，Batch 服務會傳回錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。
startTask	在聯結集區時，指定要在每個計算節點上執行的工作。 當計算節點新增至集區或計算節點重新啟動時，工作就會執行。
targetDedicatedNodes	集區中所需的專用計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。
targetLowPriorityNodes	集區中所需的低優先順序計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。
taskSchedulingPolicy	工作如何分散到集區中的計算節點。 如果未指定，則會散佈預設值。
taskSlotsPerNode	可用來在集區中單一計算節點上執行並行工作的工作位置數目。 預設值為 1。 最大值是集區 vmSize 或 256 核心數目的 4 倍小。
userAccounts	要建立於集區中每個計算節點上的用戶帳戶清單。
virtualMachineConfiguration	集區的虛擬機組態。 此屬性和 cloudServiceConfiguration 互斥，而且必須指定其中一個屬性。
vmSize	集區中的虛擬機大小。 集區中的所有虛擬機大小都相同。 如需雲端服務集區可用虛擬機大小的相關信息（使用 cloudServiceConfiguration 建立的集區），請參閱雲端服務的大小（https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/）。 Batch 支援 ExtraSmall、A1V2 和 A2V2 以外的所有雲端服務 VM 大小。 如需使用虛擬機 Marketplace 映像的集區可用 VM 大小相關信息（使用 virtualMachineConfiguration 建立的集區），請參閱虛擬機的大小（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和具有進階記憶體以外的所有 Azure VM 大小（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）。

屬性詳細資料

applicationLicenses

Batch 服務可在集區中的每個計算節點上取得應用程式授權清單。 應用程式授權清單必須是可用 Batch 服務應用程式授權的子集。 如果要求不支持的授權，集區建立將會失敗。

applicationLicenses?: string[]

屬性值

string[]

applicationPackageReferences

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

applicationPackageReferences?: ApplicationPackageReference[]

屬性值

ApplicationPackageReference[]

autoScaleEvaluationInterval

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

autoScaleEvaluationInterval?: string

屬性值

string

autoScaleFormula

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

autoScaleFormula?: string

屬性值

string

certificateReferences

要安裝在集區中每個計算節點上的憑證清單。 針對 Windows 節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs）和憑證放在該目錄中。

certificateReferences?: CertificateReference[]

屬性值

CertificateReference[]

cloudServiceConfiguration

集區的雲端服務組態。 這個屬性和 virtualMachineConfiguration 互斥，而且必須指定其中一個屬性。 如果已建立 Batch 帳戶且其 poolAllocationMode 屬性設定為 'UserSubscription'，則無法指定此屬性。

cloudServiceConfiguration?: CloudServiceConfiguration

屬性值

CloudServiceConfiguration

displayName

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

displayName?: string

屬性值

string

enableAutoScale

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

enableAutoScale?: boolean

屬性值

boolean

enableInterNodeCommunication

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

enableInterNodeCommunication?: boolean

屬性值

boolean

id

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

id: string

屬性值

string

metadata

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

metadata?: MetadataItem[]

屬性值

MetadataItem[]

mountConfiguration

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

mountConfiguration?: MountConfiguration[]

屬性值

MountConfiguration[]

networkConfiguration

集區的網路組態。

networkConfiguration?: NetworkConfiguration

屬性值

NetworkConfiguration

resizeTimeout

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

resizeTimeout?: string

屬性值

string

startTask

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

startTask?: StartTask

屬性值

StartTask

targetDedicatedNodes

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

targetDedicatedNodes?: number

屬性值

number

targetLowPriorityNodes

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

targetLowPriorityNodes?: number

屬性值

number

taskSchedulingPolicy

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

taskSchedulingPolicy?: TaskSchedulingPolicy

屬性值

TaskSchedulingPolicy

taskSlotsPerNode

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

taskSlotsPerNode?: number

屬性值

number

userAccounts

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

userAccounts?: UserAccount[]

屬性值

UserAccount[]

virtualMachineConfiguration

集區的虛擬機組態。 此屬性和 cloudServiceConfiguration 互斥，而且必須指定其中一個屬性。

virtualMachineConfiguration?: VirtualMachineConfiguration

屬性值

VirtualMachineConfiguration

vmSize

集區中的虛擬機大小。 集區中的所有虛擬機大小都相同。 如需雲端服務集區可用虛擬機大小的相關信息（使用 cloudServiceConfiguration 建立的集區），請參閱雲端服務的大小（https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/）。 Batch 支援 ExtraSmall、A1V2 和 A2V2 以外的所有雲端服務 VM 大小。 如需使用虛擬機 Marketplace 映像的集區可用 VM 大小相關信息（使用 virtualMachineConfiguration 建立的集區），請參閱虛擬機的大小（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和具有進階記憶體以外的所有 Azure VM 大小（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）。

vmSize: string

屬性值

string