Pool class
代表集區的類別。
建構函式
| Pool(Batch |
建立集區。 |
方法
建構函式詳細資料
Pool(BatchServiceClientContext)
方法詳細資料
add(PoolAddParameter, PoolAddOptionalParams)
命名集區時，請避免包含敏感性資訊，例如用戶名稱或秘密項目名稱。 此資訊可能會出現在可供Microsoft支持工程師存取的遙測記錄中。
function add(pool: PoolAddParameter, options?: PoolAddOptionalParams): Promise<PoolAddResponse>參數
- pool
- PoolAddParameter
要加入的集區。
- options
- PoolAddOptionalParams
選擇性參數
傳回
Promise<PoolAddResponse>
承諾<Models.PoolAddResponse>
add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)
function add(pool: PoolAddParameter, options: PoolAddOptionalParams, callback: ServiceCallback<void>)參數
- pool
- PoolAddParameter
要加入的集區。
- options
- PoolAddOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
add(PoolAddParameter, ServiceCallback<void>)
function add(pool: PoolAddParameter, callback: ServiceCallback<void>)參數
- pool
- PoolAddParameter
要加入的集區。
- callback
-
ServiceCallback<void>
回呼
deleteMethod(string, PoolDeleteMethodOptionalParams)
當您要求刪除集區時，會發生下列動作：集區狀態設定為刪除;已停止集區上任何進行中的重設大小作業;Batch 服務會開始將集區大小調整為零計算節點;在現有計算節點上執行的任何工作都會終止並重新排入佇列（如同已使用預設重新佇列選項要求重設大小集區作業）：最後，集區會從系統中移除。 因為重新排入佇列執行的工作，因此使用者可以藉由更新其作業以以不同的集區為目標來重新執行這些工作。 工作接著可以在新的集區上執行。 如果您想要覆寫重新佇列行為，則應該先明確地呼叫重設大小集區，將集區壓縮為零大小，再刪除集區。 如果您在處於刪除狀態的集區上呼叫 Update、Patch 或刪除 API，它會失敗，並出現 HTTP 狀態代碼 409，並出現錯誤碼 PoolBeingDeleted。
function deleteMethod(poolId: string, options?: PoolDeleteMethodOptionalParams): Promise<PoolDeleteResponse>參數
- poolId
-
string
要刪除的集區標識碼。
- options
- PoolDeleteMethodOptionalParams
選擇性參數
傳回
Promise<PoolDeleteResponse>
承諾<Models.PoolDeleteResponse>
deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(poolId: string, options: PoolDeleteMethodOptionalParams, callback: ServiceCallback<void>)參數
- poolId
-
string
要刪除的集區標識碼。
- options
- PoolDeleteMethodOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(poolId: string, callback: ServiceCallback<void>)參數
- poolId
-
string
要刪除的集區標識碼。
- callback
-
ServiceCallback<void>
回呼
disableAutoScale(string, PoolDisableAutoScaleOptionalParams)
function disableAutoScale(poolId: string, options?: PoolDisableAutoScaleOptionalParams): Promise<PoolDisableAutoScaleResponse>參數
- poolId
-
string
要停用自動調整的集區標識碼。
選擇性參數
傳回
Promise<PoolDisableAutoScaleResponse>
承諾<Models.PoolDisableAutoScaleResponse>
disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)
function disableAutoScale(poolId: string, options: PoolDisableAutoScaleOptionalParams, callback: ServiceCallback<void>)參數
- poolId
-
string
要停用自動調整的集區標識碼。
選擇性參數
- callback
-
ServiceCallback<void>
回呼
disableAutoScale(string, ServiceCallback<void>)
function disableAutoScale(poolId: string, callback: ServiceCallback<void>)參數
- poolId
-
string
要停用自動調整的集區標識碼。
- callback
-
ServiceCallback<void>
回呼
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)
如果集區上的重設大小作業正在進行中，您無法在集區上啟用自動調整。 如果集區目前已停用自動調整，您必須在要求中指定有效的自動調整公式。 如果已經啟用集區自動調整，您可以指定新的自動調整公式和/或新的評估間隔。 您無法每隔 30 秒多次針對相同的集區呼叫此 API。
function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options?: PoolEnableAutoScaleOptionalParams): Promise<PoolEnableAutoScaleResponse>參數
- poolId
-
string
要啟用自動調整的集區標識碼。
- poolEnableAutoScaleParameter
- PoolEnableAutoScaleParameter
要求的參數。
選擇性參數
傳回
Promise<PoolEnableAutoScaleResponse>
承諾<Models.PoolEnableAutoScaleResponse>
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)
function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options: PoolEnableAutoScaleOptionalParams, callback: ServiceCallback<void>)參數
- poolId
-
string
要啟用自動調整的集區標識碼。
- poolEnableAutoScaleParameter
- PoolEnableAutoScaleParameter
要求的參數。
選擇性參數
- callback
-
ServiceCallback<void>
回呼
enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)
function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, callback: ServiceCallback<void>)參數
- poolId
-
string
要啟用自動調整的集區標識碼。
- poolEnableAutoScaleParameter
- PoolEnableAutoScaleParameter
要求的參數。
- callback
-
ServiceCallback<void>
回呼
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)
此 API 主要是為了驗證自動調整公式，因為它只會傳回結果，而不需要將公式套用至集區。 集區必須啟用自動調整，才能評估公式。
function evaluateAutoScale(poolId: string, autoScaleFormula: string, options?: PoolEvaluateAutoScaleOptionalParams): Promise<PoolEvaluateAutoScaleResponse>參數
- poolId
-
string
要評估自動調整公式的集區標識碼。
- autoScaleFormula
-
string
集區中所需計算節點數目的公式。 公式會經過驗證並計算其結果，但不會套用至集區。 若要將公式套用至集區，「在集區上啟用自動調整」。 如需指定此公式的詳細資訊，請參閱在 Azure Batch 集區中自動調整計算節點（https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling）。
選擇性參數
傳回
Promise<PoolEvaluateAutoScaleResponse>
Promise<Models.PoolEvaluateAutoScaleResponse>
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)
function evaluateAutoScale(poolId: string, autoScaleFormula: string, options: PoolEvaluateAutoScaleOptionalParams, callback: ServiceCallback<AutoScaleRun>)參數
- poolId
-
string
要評估自動調整公式的集區標識碼。
- autoScaleFormula
-
string
集區中所需計算節點數目的公式。 公式會經過驗證並計算其結果，但不會套用至集區。 若要將公式套用至集區，「在集區上啟用自動調整」。 如需指定此公式的詳細資訊，請參閱在 Azure Batch 集區中自動調整計算節點（https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling）。
選擇性參數
- callback
回呼
evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)
function evaluateAutoScale(poolId: string, autoScaleFormula: string, callback: ServiceCallback<AutoScaleRun>)參數
- poolId
-
string
要評估自動調整公式的集區標識碼。
- autoScaleFormula
-
string
集區中所需計算節點數目的公式。 公式會經過驗證並計算其結果，但不會套用至集區。 若要將公式套用至集區，「在集區上啟用自動調整」。 如需指定此公式的詳細資訊，請參閱在 Azure Batch 集區中自動調整計算節點（https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling）。
- callback
回呼
exists(string, PoolExistsOptionalParams)
取得集區的基本屬性。
function exists(poolId: string, options?: PoolExistsOptionalParams): Promise<PoolExistsResponse>參數
- poolId
-
string
要取得的集區標識碼。
- options
- PoolExistsOptionalParams
選擇性參數
傳回
Promise<PoolExistsResponse>
承諾<Models.PoolExistsResponse>
exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)
function exists(poolId: string, options: PoolExistsOptionalParams, callback: ServiceCallback<boolean>)參數
- poolId
-
string
要取得的集區標識碼。
- options
- PoolExistsOptionalParams
選擇性參數
- callback
-
ServiceCallback<boolean>
回呼
exists(string, ServiceCallback<boolean>)
function exists(poolId: string, callback: ServiceCallback<boolean>)參數
- poolId
-
string
要取得的集區標識碼。
- callback
-
ServiceCallback<boolean>
回呼
get(string, PoolGetOptionalParams)
取得指定集區的相關信息。
function get(poolId: string, options?: PoolGetOptionalParams): Promise<PoolGetResponse>參數
- poolId
-
string
要取得的集區標識碼。
- options
- PoolGetOptionalParams
選擇性參數
傳回
Promise<PoolGetResponse>
承諾<Models.PoolGetResponse>
get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)
function get(poolId: string, options: PoolGetOptionalParams, callback: ServiceCallback<CloudPool>)參數
- poolId
-
string
要取得的集區標識碼。
- options
- PoolGetOptionalParams
選擇性參數
- callback
回呼
get(string, ServiceCallback<CloudPool>)
function get(poolId: string, callback: ServiceCallback<CloudPool>)參數
- poolId
-
string
要取得的集區標識碼。
- callback
回呼
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)
統計數據會匯總到帳戶中所有已存在的集區，從帳戶建立到統計數據的上次更新時間。 統計數據可能無法立即取得。 Batch 服務會定期匯總統計數據。 一般延遲約30分鐘。
function getAllLifetimeStatistics(options?: PoolGetAllLifetimeStatisticsOptionalParams): Promise<PoolGetAllLifetimeStatisticsResponse>參數
選擇性參數
傳回
Promise<PoolGetAllLifetimeStatisticsResponse>
Promise<Models.PoolGetAllLifetimeStatisticsResponse>
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)
function getAllLifetimeStatistics(options: PoolGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<PoolStatistics>)參數
選擇性參數
- callback
回呼
getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)
function getAllLifetimeStatistics(callback: ServiceCallback<PoolStatistics>)參數
- callback
回呼
list(PoolListOptionalParams)
function list(options?: PoolListOptionalParams): Promise<PoolListResponse>參數
- options
- PoolListOptionalParams
選擇性參數
傳回
Promise<PoolListResponse>
承諾<Models.PoolListResponse>
list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)
function list(options: PoolListOptionalParams, callback: ServiceCallback<CloudPoolListResult>)參數
- options
- PoolListOptionalParams
選擇性參數
- callback
回呼
list(ServiceCallback<CloudPoolListResult>)
function list(callback: ServiceCallback<CloudPoolListResult>)參數
- callback
回呼
listNext(string, PoolListNextOptionalParams)
function listNext(nextPageLink: string, options?: PoolListNextOptionalParams): Promise<PoolListResponse>參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- options
- PoolListNextOptionalParams
選擇性參數
傳回
Promise<PoolListResponse>
承諾<Models.PoolListResponse>
listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)
function listNext(nextPageLink: string, options: PoolListNextOptionalParams, callback: ServiceCallback<CloudPoolListResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- options
- PoolListNextOptionalParams
選擇性參數
- callback
回呼
listNext(string, ServiceCallback<CloudPoolListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudPoolListResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- callback
回呼
listUsageMetrics(PoolListUsageMetricsOptionalParams)
如果您未指定包含 poolId 的$filter子句，回應會包含帳戶中所有存在於傳回匯總間隔時間範圍內的集區。 如果您未指定$filter子句，包括 startTime 或 endTime，這些篩選會預設為目前可用之最後一個匯總間隔的開始和結束時間;也就是說，只會傳回最後一個匯總間隔。
function listUsageMetrics(options?: PoolListUsageMetricsOptionalParams): Promise<PoolListUsageMetricsResponse>參數
選擇性參數
傳回
Promise<PoolListUsageMetricsResponse>
Promise<Models.PoolListUsageMetricsResponse>
listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetrics(options: PoolListUsageMetricsOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)參數
選擇性參數
- callback
回呼
listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetrics(callback: ServiceCallback<PoolListUsageMetricsResult>)參數
- callback
回呼
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)
如果您未指定包含 poolId 的$filter子句，回應會包含帳戶中所有存在於傳回匯總間隔時間範圍內的集區。 如果您未指定$filter子句，包括 startTime 或 endTime，這些篩選會預設為目前可用之最後一個匯總間隔的開始和結束時間;也就是說，只會傳回最後一個匯總間隔。
function listUsageMetricsNext(nextPageLink: string, options?: PoolListUsageMetricsNextOptionalParams): Promise<PoolListUsageMetricsResponse>參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
選擇性參數
傳回
Promise<PoolListUsageMetricsResponse>
Promise<Models.PoolListUsageMetricsResponse>
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetricsNext(nextPageLink: string, options: PoolListUsageMetricsNextOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
選擇性參數
- callback
回呼
listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetricsNext(nextPageLink: string, callback: ServiceCallback<PoolListUsageMetricsResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- callback
回呼
patch(string, PoolPatchParameter, PoolPatchOptionalParams)
這隻會取代要求中指定的集區屬性。 例如，如果集區有與其相關聯的 StartTask，且要求未指定 StartTask 元素，則 Pool 會保留現有的 StartTask。
function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options?: PoolPatchOptionalParams): Promise<PoolPatchResponse>參數
- poolId
-
string
要更新的集區標識碼。
- poolPatchParameter
- PoolPatchParameter
要求的參數。
- options
- PoolPatchOptionalParams
選擇性參數
傳回
Promise<PoolPatchResponse>
承諾<Models.PoolPatchResponse>
patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>)
function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options: PoolPatchOptionalParams, callback: ServiceCallback<void>)參數
- poolId
-
string
要更新的集區標識碼。
- poolPatchParameter
- PoolPatchParameter
要求的參數。
- options
- PoolPatchOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
patch(string, PoolPatchParameter, ServiceCallback<void>)
function patch(poolId: string, poolPatchParameter: PoolPatchParameter, callback: ServiceCallback<void>)參數
- poolId
-
string
要更新的集區標識碼。
- poolPatchParameter
- PoolPatchParameter
要求的參數。
- callback
-
ServiceCallback<void>
回呼
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)
此作業只能在集區的配置狀態穩定時執行。 當此作業執行時，配置狀態會從穩定變更為重設大小。
function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options?: PoolRemoveNodesOptionalParams): Promise<PoolRemoveNodesResponse>參數
- poolId
-
string
您要從中移除計算節點的集區識別碼。
- nodeRemoveParameter
- NodeRemoveParameter
要求的參數。
- options
- PoolRemoveNodesOptionalParams
選擇性參數
傳回
Promise<PoolRemoveNodesResponse>
Promise<Models.PoolRemoveNodes回應>
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>)
function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options: PoolRemoveNodesOptionalParams, callback: ServiceCallback<void>)參數
- poolId
-
string
您要從中移除計算節點的集區識別碼。
- nodeRemoveParameter
- NodeRemoveParameter
要求的參數。
- options
- PoolRemoveNodesOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)
function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, callback: ServiceCallback<void>)參數
- poolId
-
string
您要從中移除計算節點的集區識別碼。
- nodeRemoveParameter
- NodeRemoveParameter
要求的參數。
- callback
-
ServiceCallback<void>
回呼
resize(string, PoolResizeParameter, PoolResizeOptionalParams)
只有當集區配置狀態穩定時，您才能調整集區的大小。 如果集區已經重設大小，要求會失敗，狀態代碼為 409。 當您調整集區大小時，集區的配置狀態會從穩定變更為重設大小。 您無法調整針對自動調整設定的集區大小。 如果您嘗試這樣做，Batch 服務會傳回錯誤 409。 如果您向下調整集區的大小，Batch 服務會選擇要移除的計算節點。 若要移除特定的計算節點，請改用集區移除計算節點 API。
function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options?: PoolResizeOptionalParams): Promise<PoolResizeResponse>參數
- poolId
-
string
要重設大小的集區標識碼。
- poolResizeParameter
- PoolResizeParameter
要求的參數。
- options
- PoolResizeOptionalParams
選擇性參數
傳回
Promise<PoolResizeResponse>
承諾<Models.PoolResizeResponse>
resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>)
function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options: PoolResizeOptionalParams, callback: ServiceCallback<void>)參數
- poolId
-
string
要重設大小的集區標識碼。
- poolResizeParameter
- PoolResizeParameter
要求的參數。
- options
- PoolResizeOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
resize(string, PoolResizeParameter, ServiceCallback<void>)
function resize(poolId: string, poolResizeParameter: PoolResizeParameter, callback: ServiceCallback<void>)參數
- poolId
-
string
要重設大小的集區標識碼。
- poolResizeParameter
- PoolResizeParameter
要求的參數。
- callback
-
ServiceCallback<void>
回呼
stopResize(string, PoolStopResizeOptionalParams)
這不會在重設大小作業之前將集區還原為先前的狀態：它只會停止進行任何進一步的變更，而集區會維持其目前狀態。 停止之後，集區會穩定在停止作業完成時的計算節點數目。 在停止作業期間，集區配置狀態會先變更為停止，然後再變更為穩定。 重設大小作業不需要明確重設大小集區要求;此 API 也可以用來在建立集區時停止初始重設大小。
function stopResize(poolId: string, options?: PoolStopResizeOptionalParams): Promise<PoolStopResizeResponse>參數
- poolId
-
string
要停止重設大小之集區的標識碼。
- options
- PoolStopResizeOptionalParams
選擇性參數
傳回
Promise<PoolStopResizeResponse>
承諾<Models.PoolStopResizeResponse>
stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)
function stopResize(poolId: string, options: PoolStopResizeOptionalParams, callback: ServiceCallback<void>)參數
- poolId
-
string
要停止重設大小之集區的標識碼。
- options
- PoolStopResizeOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
stopResize(string, ServiceCallback<void>)
function stopResize(poolId: string, callback: ServiceCallback<void>)參數
- poolId
-
string
要停止重設大小之集區的標識碼。
- callback
-
ServiceCallback<void>
回呼
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)
這會完全取代集區的所有可更新屬性。 例如，如果集區有與其相關聯的 StartTask，且未使用此要求指定 StartTask，則 Batch 服務將會移除現有的 StartTask。
function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options?: PoolUpdatePropertiesOptionalParams): Promise<PoolUpdatePropertiesResponse>參數
- poolId
-
string
要更新的集區標識碼。
- poolUpdatePropertiesParameter
- PoolUpdatePropertiesParameter
要求的參數。
選擇性參數
傳回
Promise<PoolUpdatePropertiesResponse>
Promise<Models.PoolUpdateProperties回應>
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>)
function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options: PoolUpdatePropertiesOptionalParams, callback: ServiceCallback<void>)參數
- poolId
-
string
要更新的集區標識碼。
- poolUpdatePropertiesParameter
- PoolUpdatePropertiesParameter
要求的參數。
選擇性參數
- callback
-
ServiceCallback<void>
回呼
updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)
function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, callback: ServiceCallback<void>)參數
- poolId
-
string
要更新的集區標識碼。
- poolUpdatePropertiesParameter
- PoolUpdatePropertiesParameter
要求的參數。
- callback
-
ServiceCallback<void>
回呼