BatchPoolCreateOptions interface
建立 Azure Batch 池的參數。
屬性
| application |
要安裝在集區中每個計算節點上的套件清單。 建立池時，套件的應用程式 ID 必須完全限定（/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft。Batch/batchAccounts/{accountName}/applications/{applicationName}）。 封裝參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新映射為止。 任何指定的集區上最多有10個套件參考。 |
| auto |
根據自動調整公式自動調整集區大小的時間間隔。 預設值為15分鐘。 最小值和最大值分別為 5 分鐘和 168 小時。 如果您指定小於 5 分鐘或大於 168 小時的值，Batch 服務會傳回錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 時間長度以ISO 8601格式規定。 |
| auto |
集區中所需計算節點數目的公式。 如果 enableAutoScale 設定為 false，則不得指定此屬性。 如果 enableAutoScale 設定為 true，則為必要專案。 在建立集區之前，會先檢查公式是否有效。 如果公式無效，Batch 服務會以詳細的錯誤資訊拒絕要求。 關於指定此公式的更多資訊，請參閱「自動縮放計算節點於Azure Batch池中」（https://learn.microsoft.com/azure/batch/batch-automatic-scaling）。 |
| display |
集區的顯示名稱。 顯示名稱不是唯一的，而且可以包含最大長度為 1024 的任何 Unicode 字元。 |
| enable |
集區大小是否應該隨著時間自動調整。 如果為 false，則必須指定至少一個 targetDedicatedNodes 和 targetLowPriorityNodes。 如果為 true，則需要 autoScaleFormula 屬性，而且集區會根據公式自動重設大小。 預設值為 false。 |
| enable |
集區是否允許計算節點之間的直接通訊。 啟用節點間通訊會限制集區的大小上限，因為集區的計算節點有部署限制。 這可能會導致集區無法達到其所需的大小。 預設值為 false。 |
| id | 可唯一識別帳戶內集區的字串。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。 標識符會保留大小寫且不區分大小寫（也就是說，您可能不會在帳戶內有兩個只區分大小寫的集區標識符）。 |
| metadata | 與集區相關聯的名稱/值組清單做為元數據。 Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。 |
| mount |
在集區的整個存留期內，使用指定的檔案系統掛接記憶體。 使用Azure檔案共享、NFS、CIFS或Blobfuse檔案系統掛載儲存裝置。 |
| network |
集區的網路組態。 |
| resize |
將計算節點配置至集區的逾時。 此逾時僅適用於手動調整;當 enableAutoScale 設定為 true 時，它沒有任何作用。 預設值為15分鐘。 最小值為 5 分鐘。 如果您指定小於 5 分鐘的值，Batch 服務會傳回錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 時間長度以ISO 8601格式規定。 |
| start |
在聯結集區時，指定要在每個計算節點上執行的工作。 當計算節點新增至集區或計算節點重新啟動時，工作就會執行。 |
| target |
集區中所需的專用計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。 |
| target |
集區中所需的現成/低優先順序計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。 |
| task |
工作如何分散到集區中的計算節點。 如果未指定，則會散佈預設值。 |
| task |
可用於在集區中單一計算節點上執行並行工作的工作位置數目。 預設值是 1。 最大值是集區 vmSize 或 256 核心數目的 4 倍小。 |
| upgrade |
集區的升級原則。 描述升級原則 - 自動、手動或滾動。 |
| user |
要建立於集區中每個計算節點上的用戶帳戶清單。 |
| virtual |
集區的虛擬機組態。 您必須指定這個屬性。 |
| vm |
集區中的虛擬機大小。 集區中的所有虛擬機大小都相同。 關於使用 虛擬機器 Marketplace 映像檔（使用 virtualMachineConfiguration 建立的池）的可用虛擬機大小資訊，請參閱 Azure 中的 虛擬機器 大小（https://learn.microsoft.com/azure/virtual-machines/sizes/overview）。 批次支援除STANDARD_A0及有高級儲存空間（STANDARD_GS、STANDARD_DS 和 STANDARD_DSV2 系列）外的所有Azure虛擬機大小。 |
屬性詳細資料
applicationPackageReferences
要安裝在集區中每個計算節點上的套件清單。 建立池時，套件的應用程式 ID 必須完全限定（/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft。Batch/batchAccounts/{accountName}/applications/{applicationName}）。 封裝參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新映射為止。 任何指定的集區上最多有10個套件參考。
applicationPackageReferences?: BatchApplicationPackageReference[]屬性值
autoScaleEvaluationInterval
根據自動調整公式自動調整集區大小的時間間隔。 預設值為15分鐘。 最小值和最大值分別為 5 分鐘和 168 小時。 如果您指定小於 5 分鐘或大於 168 小時的值，Batch 服務會傳回錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 時間長度以ISO 8601格式規定。
autoScaleEvaluationInterval?: string屬性值
string
autoScaleFormula
集區中所需計算節點數目的公式。 如果 enableAutoScale 設定為 false，則不得指定此屬性。 如果 enableAutoScale 設定為 true，則為必要專案。 在建立集區之前，會先檢查公式是否有效。 如果公式無效，Batch 服務會以詳細的錯誤資訊拒絕要求。 關於指定此公式的更多資訊，請參閱「自動縮放計算節點於Azure Batch池中」（https://learn.microsoft.com/azure/batch/batch-automatic-scaling）。
autoScaleFormula?: string屬性值
string
displayName
集區的顯示名稱。 顯示名稱不是唯一的，而且可以包含最大長度為 1024 的任何 Unicode 字元。
displayName?: string屬性值
string
enableAutoScale
集區大小是否應該隨著時間自動調整。 如果為 false，則必須指定至少一個 targetDedicatedNodes 和 targetLowPriorityNodes。 如果為 true，則需要 autoScaleFormula 屬性，而且集區會根據公式自動重設大小。 預設值為 false。
enableAutoScale?: boolean屬性值
boolean
enableInterNodeCommunication
集區是否允許計算節點之間的直接通訊。 啟用節點間通訊會限制集區的大小上限，因為集區的計算節點有部署限制。 這可能會導致集區無法達到其所需的大小。 預設值為 false。
enableInterNodeCommunication?: boolean屬性值
boolean
id
可唯一識別帳戶內集區的字串。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。 標識符會保留大小寫且不區分大小寫（也就是說，您可能不會在帳戶內有兩個只區分大小寫的集區標識符）。
id: string屬性值
string
metadata
與集區相關聯的名稱/值組清單做為元數據。 Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。
metadata?: BatchMetadataItem[]屬性值
mountConfiguration
在集區的整個存留期內，使用指定的檔案系統掛接記憶體。 使用Azure檔案共享、NFS、CIFS或Blobfuse檔案系統掛載儲存裝置。
mountConfiguration?: MountConfiguration[]屬性值
networkConfiguration
resizeTimeout
將計算節點配置至集區的逾時。 此逾時僅適用於手動調整;當 enableAutoScale 設定為 true 時，它沒有任何作用。 預設值為15分鐘。 最小值為 5 分鐘。 如果您指定小於 5 分鐘的值，Batch 服務會傳回錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 時間長度以ISO 8601格式規定。
resizeTimeout?: string屬性值
string
startTask
targetDedicatedNodes
集區中所需的專用計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。
targetDedicatedNodes?: number屬性值
number
targetLowPriorityNodes
集區中所需的現成/低優先順序計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。
targetLowPriorityNodes?: number屬性值
number
taskSchedulingPolicy
工作如何分散到集區中的計算節點。 如果未指定，則會散佈預設值。
taskSchedulingPolicy?: BatchTaskSchedulingPolicy屬性值
taskSlotsPerNode
可用於在集區中單一計算節點上執行並行工作的工作位置數目。 預設值是 1。 最大值是集區 vmSize 或 256 核心數目的 4 倍小。
taskSlotsPerNode?: number屬性值
number
upgradePolicy
userAccounts
virtualMachineConfiguration
集區的虛擬機組態。 您必須指定這個屬性。
virtualMachineConfiguration?: VirtualMachineConfiguration屬性值
vmSize
集區中的虛擬機大小。 集區中的所有虛擬機大小都相同。 關於使用 虛擬機器 Marketplace 映像檔（使用 virtualMachineConfiguration 建立的池）的可用虛擬機大小資訊，請參閱 Azure 中的 虛擬機器 大小（https://learn.microsoft.com/azure/virtual-machines/sizes/overview）。 批次支援除STANDARD_A0及有高級儲存空間（STANDARD_GS、STANDARD_DS 和 STANDARD_DSV2 系列）外的所有Azure虛擬機大小。
vmSize: string屬性值
string