PoolOperations 類別

將集區新增至指定的帳號。

命名集區時，請避免包含敏感性資訊，例如使用者名稱或秘密專案名稱。 此資訊可能會出現在 Microsoft 支援服務工程師可存取的遙測記錄中。

add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

如果 raw=true，則為 None 或 ClientRawResponse

傳回類型

例外狀況

從指定的帳號刪除集區。

當您要求刪除集區時，會發生下列動作：集區狀態會設定為刪除;集區上任何進行中的調整大小作業會停止;Batch 服務會開始將集區大小調整為零計算節點;任何在現有計算節點上執行的工作都會終止，並重新排入佇列 (，就像使用預設重新佇列選項要求調整大小集區作業一樣) ;最後，集區會從系統中移除。 因為重新排入佇列執行中的工作，所以使用者可以藉由更新其作業以以不同的集區為目標，來重新執行這些工作。 工作接著可以在新的集區上執行。 如果您想要覆寫重新佇列行為，則應該先明確呼叫 [調整集區大小]，將集區壓縮為零大小，再刪除集區。 如果您在集區上以刪除狀態呼叫更新、修補或刪除 API，它會失敗，HTTP 狀態碼為 409，錯誤碼 PoolBeingDeleted。

delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

如果 raw=true，則為 None 或 ClientRawResponse

傳回類型

例外狀況

停用集區的自動調整。

disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

如果 raw=true，則為 None 或 ClientRawResponse

傳回類型

例外狀況

啟用集區的自動調整。

如果集區上的調整大小作業正在進行中，您就無法在集區上啟用自動調整。 如果集區目前已停用自動調整，您必須在要求中指定有效的自動調整公式。 如果已啟用集區的自動調整，您可以指定新的自動調整公式和/或新的評估間隔。 您無法每隔 30 秒多次呼叫相同的集區此 API。

enable_auto_scale(pool_id, auto_scale_formula=None, auto_scale_evaluation_interval=None, pool_enable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

如果 raw=true，則為 None 或 ClientRawResponse

傳回類型

例外狀況

取得評估集區上自動調整公式的結果。

此 API 主要是用來驗證自動調整公式，因為它只會傳回結果，而不需要將公式套用至集區。 集區必須啟用自動調整，才能評估公式。

evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

如果 raw=true，AutoScaleRun 或 ClientRawResponse

傳回類型

例外狀況

取得集區的基本屬性。

exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

bool 或 ClientRawResponse if raw=true

傳回類型

例外狀況

取得指定集區的相關資訊。

get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

如果 raw=true，CloudPool 或 ClientRawResponse

傳回類型

例外狀況

列出指定帳戶中的所有集區。

list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

CloudPool 實例之類的反覆運算器

傳回類型

例外狀況

針對指定的帳號，列出依集區匯總的個別時間間隔使用量計量。

如果您未指定包含 poolId 的$filter子句，回應會包含帳戶中存在於傳回匯總間隔時間範圍內的所有集區。 如果您未指定包含 startTime 或 endTime 的$filter子句，這些篩選預設為目前可用最後一個匯總間隔的開始和結束時間;也就是說，只會傳回最後一個匯總間隔。

list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

像是 PoolUsageMetrics 實例的反覆運算器

傳回類型

例外狀況

更新指定集區的屬性。

這只會取代要求中指定的集區屬性。 例如，如果集區有與其相關聯的 StartTask，而且要求未指定 StartTask 元素，則 Pool 會保留現有的 StartTask。

patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

如果 raw=true，則為 None 或 ClientRawResponse

傳回類型

例外狀況

從指定的集區中移除計算節點。

只有在集區的配置狀態穩定時，才能執行這項作業。 當此作業執行時，配置狀態會從穩定變更為調整大小。 每個要求最多可以移除 100 個節點。

remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

如果 raw=true，則為 None 或 ClientRawResponse

傳回類型

例外狀況

變更指派給集區的計算節點數目。

您只能在集區配置狀態穩定時調整集區的大小。 如果集區已經調整大小，要求就會失敗，狀態碼為 409。 當您調整集區的大小時，集區的配置狀態會從穩定變更為調整大小。 您無法調整針對自動調整設定的集區大小。 如果您嘗試這樣做，Batch 服務會傳回錯誤 409。 如果您向下調整集區的大小，Batch 服務會選擇要移除的計算節點。 若要移除特定的計算節點，請改用集區移除計算節點 API。

resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

如果 raw=true，則為 None 或 ClientRawResponse

傳回類型

例外狀況

停止集區上的持續調整大小作業。

這不會在調整大小作業之前將集區還原到先前的狀態：它只會停止進行的任何進一步變更，而且集區會維護其目前的狀態。 停止之後，集區會穩定完成停止作業時所在的計算節點數目。 在停止作業期間，集區配置狀態會先變更為停止，然後再變更為穩定。 調整大小作業不需要明確調整大小集區要求;此 API 也可用來在建立集區時停止初始調整大小。

stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

如果 raw=true，則為 None 或 ClientRawResponse

傳回類型

例外狀況

更新指定集區的屬性。

這會完全取代集區的所有可更新屬性。 例如，如果集區有與其相關聯的 StartTask，而且未使用此要求指定 StartTask，則 Batch 服務會移除現有的 StartTask。

update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)

參數

傳回

如果 raw=true，則為 None 或 ClientRawResponse

傳回類型

例外狀況

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>