TaskOperations 類別
TaskOperations 作業。
您不應該直接具現化此類別,而是建立用戶端實例來為您建立它,並將其附加為屬性。
- 繼承
-
builtins.objectTaskOperations
建構函式
TaskOperations(client, config, serializer, deserializer)
參數
- client
服務要求的用戶端。
- config
服務用戶端的設定。
- serializer
物件模型序列化程式。
- deserializer
物件模型還原序列化程式。
變數
- api_version
要用於要求的 API 版本。 常數值:「2023-05-01.17.0」。
方法
add |
將工作加入至指定的作業。 除了完成之外,任務的最大存留期為 180 天。 如果工作尚未在 180 天內完成新增,Batch 服務將會終止,並保留在當時的狀態。 |
add_collection |
將工作的集合加入至指定的作業。 請注意,每個工作都必須有唯一識別碼。 Batch 服務可能不會依照此要求中提交工作的相同順序傳回每個工作的結果。 如果伺服器在要求期間逾時或連接已關閉,則要求可能已部分或完全處理,或完全未處理。 在這種情況下,使用者應該重新發出要求。 請注意,重新發出要求時,使用者必須正確處理失敗。 例如,您應該在重試期間使用相同的工作識別碼,如此一來,如果先前的作業成功,重試就不會意外建立額外的工作。 如果回應包含任何無法新增的工作,用戶端可以重試要求。 在重試中,只重新提交無法新增的工作,以及省略第一次嘗試成功新增的工作最有效率。 除了完成之外,工作的最大存留期是 180 天。 如果工作在 180 天內尚未完成,Batch 服務將會終止,並保留在當時的狀態。 |
delete |
從指定的作業中刪除工作。 刪除工作時,不論保留時間) 為何,其目錄中的計算節點上的所有檔案也會遭到刪除 (。 針對多重實例工作,刪除工作作業會同步套用至主要工作;子工作及其檔案會在背景以非同步方式刪除。 |
get |
取得指定之工作的相關資訊。 針對多重實例工作,affinityId、executionInfo 和 nodeInfo 等資訊會參考主要工作。 使用清單子工作 API 來擷取子工作的相關資訊。 |
list |
列出與指定之作業相關聯的所有工作。 針對多重實例工作,affinityId、executionInfo 和 nodeInfo 等資訊會參考主要工作。 使用清單子工作 API 來擷取子工作的相關資訊。 |
list_subtasks |
列出與指定之多重實例工作相關聯的所有子工作。 如果 Task 不是多重實例 Task,則這會傳回空的集合。 |
reactivate |
重新啟用工作,即使重試計數已耗盡,仍可再次執行。 重新啟用讓工作符合重試資格,最多達到重試計數上限。 工作的狀態會變更為使用中。 由於工作已不再處於已完成狀態,因此在重新啟用之後,將無法再使用任何先前的結束代碼或失敗資訊。 每次重新開機工作時,其重試計數會重設為 0。 未完成的工作或先前成功完成的工作會失敗, (結束代碼為 0) 。 此外,如果作業已完成 (或正在終止或刪除) ,則會失敗。 |
terminate |
終止指定的工作。 當工作終止時,它會移至已完成狀態。 針對多重實例工作,終止的工作作業會同步套用至主要工作;子工作接著會在背景以非同步方式終止。 |
update |
更新指定之 Task 的屬性。 |
add
將工作加入至指定的作業。
除了完成之外,任務的最大存留期為 180 天。 如果工作尚未在 180 天內完成新增,Batch 服務將會終止,並保留在當時的狀態。
add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
add_collection
將工作的集合加入至指定的作業。
請注意,每個工作都必須有唯一識別碼。 Batch 服務可能不會依照此要求中提交工作的相同順序傳回每個工作的結果。 如果伺服器在要求期間逾時或連接已關閉,則要求可能已部分或完全處理,或完全未處理。 在這種情況下,使用者應該重新發出要求。 請注意,重新發出要求時,使用者必須正確處理失敗。 例如,您應該在重試期間使用相同的工作識別碼,如此一來,如果先前的作業成功,重試就不會意外建立額外的工作。 如果回應包含任何無法新增的工作,用戶端可以重試要求。 在重試中,只重新提交無法新增的工作,以及省略第一次嘗試成功新增的工作最有效率。 除了完成之外,工作的最大存留期是 180 天。 如果工作在 180 天內尚未完成,Batch 服務將會終止,並保留在當時的狀態。
add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)
參數
- value
- list of TaskAddParameter
要加入的工作集合。 此集合的總序列化大小必須小於 4MB。 例如,如果每個工作的資源檔或環境變數) 大於 4MB (,則要求將會失敗,且程式碼 'RequestBodyTooLarge' 會失敗,而且應該以較少的工作重試。
- threads
- int
新增工作時要平行使用的執行緒數目。 如果指定且大於 0,將會啟動其他執行緒來提交要求,並等候它們完成。 否則會在主執行緒上循序提交add_collection要求
傳回
TaskAddCollectionResult 如果 raw=true,則 ClientRawResponse 為
傳回類型
例外狀況
delete
從指定的作業中刪除工作。
刪除工作時,不論保留時間) 為何,其目錄中的計算節點上的所有檔案也會遭到刪除 (。 針對多重實例工作,刪除工作作業會同步套用至主要工作;子工作及其檔案會在背景以非同步方式刪除。
delete(job_id, task_id, task_delete_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
get
取得指定之工作的相關資訊。
針對多重實例工作,affinityId、executionInfo 和 nodeInfo 等資訊會參考主要工作。 使用清單子工作 API 來擷取子工作的相關資訊。
get(job_id, task_id, task_get_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true,CloudTask 或 ClientRawResponse
傳回類型
例外狀況
list
列出與指定之作業相關聯的所有工作。
針對多重實例工作,affinityId、executionInfo 和 nodeInfo 等資訊會參考主要工作。 使用清單子工作 API 來擷取子工作的相關資訊。
list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
Iterator,例如 CloudTask 的實例
傳回類型
例外狀況
list_subtasks
列出與指定之多重實例工作相關聯的所有子工作。
如果 Task 不是多重實例 Task,則這會傳回空的集合。
list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true,CloudTaskListSubtasksResult 或 ClientRawResponse
傳回類型
例外狀況
reactivate
重新啟用工作,即使重試計數已耗盡,仍可再次執行。
重新啟用讓工作符合重試資格,最多達到重試計數上限。 工作的狀態會變更為使用中。 由於工作已不再處於已完成狀態,因此在重新啟用之後,將無法再使用任何先前的結束代碼或失敗資訊。 每次重新開機工作時,其重試計數會重設為 0。 未完成的工作或先前成功完成的工作會失敗, (結束代碼為 0) 。 此外,如果作業已完成 (或正在終止或刪除) ,則會失敗。
reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
terminate
終止指定的工作。
當工作終止時,它會移至已完成狀態。 針對多重實例工作,終止的工作作業會同步套用至主要工作;子工作接著會在背景以非同步方式終止。
terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
update
更新指定之 Task 的屬性。
update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)
參數
- constraints
- TaskConstraints
套用至此工作的條件約束。 如果省略,則會將 Task 指定為預設條件約束。 對於多重實例工作,更新保留時間僅適用于主要工作,不適用於子工作。
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
屬性
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應