JobOperations 類別
JobOperations 作業。
您不應該直接具現化這個類別，而是建立將為您建立的 Client 實例，並將它附加為屬性。
- 繼承
-
builtins.objectJobOperations
建構函式
JobOperations(client, config, serializer, deserializer)參數
- client
服務要求的用戶端。
- config
服務用戶端的設定。
- serializer
物件模型序列化程式。
- deserializer
物件模型還原序列化程式。
變數
- api_version
要用於要求的 API 版本。 常數值：「2023-05-01.17.0」。
方法
| add |
將作業加入至指定的帳號。 Batch 服務支援兩種方式來控制在作業中完成的工作。 在第一種方法中，使用者會指定作業管理員工作。 當 Batch 服務準備好啟動作業時，就會啟動此工作。 作業管理員工作會使用工作 API 控制在此作業下執行的其他所有工作。 在第二種方法中，使用者會使用工作 API，直接控制使用中作業下的工作執行。 另請注意：命名作業時，請避免包含敏感性資訊，例如使用者名稱或秘密專案名稱。 此資訊可能會出現在 Microsoft 支援服務工程師可存取的遙測記錄中。 |
| delete |
刪除作業。 刪除作業也會刪除屬於該作業的所有工作，以及所有作業統計資料。 這也會覆寫 Task 資料的保留期間;也就是說，如果作業包含仍保留在計算節點上的工作，Batch 服務會刪除這些工作的工作目錄及其所有內容。 收到刪除作業要求時，Batch 服務會將作業設定為刪除狀態。 處於刪除狀態之作業上的所有更新作業都會失敗，狀態碼 409 (衝突) ，並顯示正在刪除作業的其他資訊。 |
| disable |
停用指定的作業，以防止新的工作執行。 Batch 服務會立即將作業移至停用狀態。 Batch 接著會使用 disableTasks 參數來判斷目前執行中作業的工作所要執行的作業。 作業會維持停用狀態，直到停用作業完成，而且所有工作都已根據 disableTasks 選項來處理;作業接著會移至停用狀態。 在作業返回作用中狀態之前，不會啟動任何新的工作。 如果您嘗試停用處于作用中、停用或停用以外的任何狀態的作業，要求會失敗，狀態碼為 409。 |
| enable |
啟用指定的作業，允許執行新的工作。 當您呼叫此 API 時，Batch 服務會將停用的作業設定為啟用狀態。 完成此作業之後，作業會移至作用中狀態，並在作業繼續下排程新的工作。 Batch 服務不允許工作保持作用中狀態超過 180 天。 因此，如果您啟用作業，其中包含超過 180 天前新增的作用中工作，這些工作將不會執行。 |
| get |
取得指定之作業的相關資訊。 |
| get_task_counts |
取得指定之作業的工作計數。 工作計數會依作用中、執行中或已完成的工作狀態，以及成功或失敗的工作計數來提供工作計數。 準備狀態中的工作會計算為執行中。 請注意，傳回的數位不一定是最新的。 如果您需要確切的工作計數，請使用清單查詢。 |
| list |
列出指定帳戶中的所有作業。 |
| list_from_job_schedule |
列出在指定的作業排程下建立的作業。 |
| list_preparation_and_release_task_status |
列出作業執行所在計算節點中指定作業的作業準備和作業發行工作的執行狀態。 此 API 會傳回所有執行作業準備或作業發行工作之計算節點上的工作準備和作業發行工作狀態。 這包括自集區中移除後已移除的計算節點。 如果在沒有作業準備或作業發行工作的作業上叫用此 API，Batch 服務會傳回 HTTP 狀態碼 409 (衝突) ，並出現 JobPreparationTaskNotSpecified 的錯誤碼。 |
| patch |
更新指定作業的屬性。 這只會取代要求中指定的 Job 屬性。 例如，如果作業具有條件約束，而且要求未指定條件約束專案，則 Job 會保留現有的條件約束。 |
| terminate |
終止指定的作業，並將它標示為已完成。 收到終止作業要求時，Batch 服務會將作業設定為終止狀態。 Batch 服務接著會終止與作業相關聯的任何執行中工作，並執行任何必要的作業發行工作。 然後作業會移至已完成的狀態。 如果作業處於作用中狀態的任何工作，它們會維持在作用中狀態。 作業終止之後，就無法新增新的工作，而且不會排程任何剩餘的作用中工作。 |
| update |
更新指定作業的屬性。 這會完全取代作業的所有可更新屬性。 例如，如果作業有與其相關聯的條件約束，而且未使用此要求指定條件約束，則 Batch 服務將會移除現有的條件約束。 |
add
將作業加入至指定的帳號。
Batch 服務支援兩種方式來控制在作業中完成的工作。 在第一種方法中，使用者會指定作業管理員工作。 當 Batch 服務準備好啟動作業時，就會啟動此工作。 作業管理員工作會使用工作 API 控制在此作業下執行的其他所有工作。 在第二種方法中，使用者會使用工作 API，直接控制使用中作業下的工作執行。 另請注意：命名作業時，請避免包含敏感性資訊，例如使用者名稱或秘密專案名稱。 此資訊可能會出現在 Microsoft 支援服務工程師可存取的遙測記錄中。
add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true，則為 None 或 ClientRawResponse
傳回類型
例外狀況
delete
刪除作業。
刪除作業也會刪除屬於該作業的所有工作，以及所有作業統計資料。 這也會覆寫 Task 資料的保留期間;也就是說，如果作業包含仍保留在計算節點上的工作，Batch 服務會刪除這些工作的工作目錄及其所有內容。 收到刪除作業要求時，Batch 服務會將作業設定為刪除狀態。 處於刪除狀態之作業上的所有更新作業都會失敗，狀態碼 409 (衝突) ，並顯示正在刪除作業的其他資訊。
delete(job_id, job_delete_options=None, custom_headers=None, raw=False, **operation_config)參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true，則為 None 或 ClientRawResponse
傳回類型
例外狀況
disable
停用指定的作業，以防止新的工作執行。
Batch 服務會立即將作業移至停用狀態。 Batch 接著會使用 disableTasks 參數來判斷目前執行中作業的工作所要執行的作業。 作業會維持停用狀態，直到停用作業完成，而且所有工作都已根據 disableTasks 選項來處理;作業接著會移至停用狀態。 在作業返回作用中狀態之前，不會啟動任何新的工作。 如果您嘗試停用處于作用中、停用或停用以外的任何狀態的作業，要求會失敗，狀態碼為 409。
disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true，則為 None 或 ClientRawResponse
傳回類型
例外狀況
enable
啟用指定的作業，允許執行新的工作。
當您呼叫此 API 時，Batch 服務會將停用的作業設定為啟用狀態。 完成此作業之後，作業會移至作用中狀態，並在作業繼續下排程新的工作。 Batch 服務不允許工作保持作用中狀態超過 180 天。 因此，如果您啟用作業，其中包含超過 180 天前新增的作用中工作，這些工作將不會執行。
enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true，則為 None 或 ClientRawResponse
傳回類型
例外狀況
get
取得指定之作業的相關資訊。
get(job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config)參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true，CloudJob 或 ClientRawResponse
傳回類型
例外狀況
get_task_counts
取得指定之作業的工作計數。
工作計數會依作用中、執行中或已完成的工作狀態，以及成功或失敗的工作計數來提供工作計數。 準備狀態中的工作會計算為執行中。 請注意，傳回的數位不一定是最新的。 如果您需要確切的工作計數，請使用清單查詢。
get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true，TaskCountsResult 或 ClientRawResponse
傳回類型
例外狀況
list
列出指定帳戶中的所有作業。
list(job_list_options=None, custom_headers=None, raw=False, **operation_config)參數
- operation_config
作業組態覆寫。
傳回
Iterator，例如 CloudJob 的實例
傳回類型
例外狀況
list_from_job_schedule
列出在指定的作業排程下建立的作業。
list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)參數
- operation_config
作業組態覆寫。
傳回
Iterator，例如 CloudJob 的實例
傳回類型
例外狀況
list_preparation_and_release_task_status
列出作業執行所在計算節點中指定作業的作業準備和作業發行工作的執行狀態。
此 API 會傳回所有執行作業準備或作業發行工作之計算節點上的工作準備和作業發行工作狀態。 這包括自集區中移除後已移除的計算節點。 如果在沒有作業準備或作業發行工作的作業上叫用此 API，Batch 服務會傳回 HTTP 狀態碼 409 (衝突) ，並出現 JobPreparationTaskNotSpecified 的錯誤碼。
list_preparation_and_release_task_status(job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config)參數
- job_list_preparation_and_release_task_status_options
- JobListPreparationAndReleaseTaskStatusOptions
作業的其他參數
- operation_config
作業組態覆寫。
傳回
Iterator，例如 JobPreparationAndReleaseTaskExecutionInformation 的實例
傳回類型
例外狀況
patch
更新指定作業的屬性。
這只會取代要求中指定的 Job 屬性。 例如，如果作業具有條件約束，而且要求未指定條件約束專案，則 Job 會保留現有的條件約束。
patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true，則為 None 或 ClientRawResponse
傳回類型
例外狀況
terminate
終止指定的作業，並將它標示為已完成。
收到終止作業要求時，Batch 服務會將作業設定為終止狀態。 Batch 服務接著會終止與作業相關聯的任何執行中工作，並執行任何必要的作業發行工作。 然後作業會移至已完成的狀態。 如果作業處於作用中狀態的任何工作，它們會維持在作用中狀態。 作業終止之後，就無法新增新的工作，而且不會排程任何剩餘的作用中工作。
terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)參數
- terminate_reason
- str
- operation_config
作業組態覆寫。
傳回
如果 raw=true，則為 None 或 ClientRawResponse
傳回類型
例外狀況
update
更新指定作業的屬性。
這會完全取代作業的所有可更新屬性。 例如，如果作業有與其相關聯的條件約束，而且未使用此要求指定條件約束，則 Batch 服務將會移除現有的條件約束。
update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)參數
- 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'>
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應