共用方式為

CloudJob 類別

  • 參考

Azure Batch作業。

繼承
Model
CloudJob

建構函式

CloudJob(*, id: str = None, display_name: str = None, uses_task_dependencies: bool = None, url: str = None, e_tag: str = None, last_modified=None, creation_time=None, state=None, state_transition_time=None, previous_state=None, previous_state_transition_time=None, priority: int = None, allow_task_preemption: bool = None, max_parallel_tasks: int = -1, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, pool_info=None, on_all_tasks_complete=None, on_task_failure=None, network_configuration=None, metadata=None, execution_info=None, stats=None, **kwargs)

參數

id
str
必要

識別碼是保留大小寫且不區分大小寫的 (，也就是說，您可能在帳戶中沒有兩個識別碼，只有大小寫) 不同。

display_name
str
必要
uses_task_dependencies
bool
必要

作業中的工作是否可以彼此定義相依性。 預設值為 false。

url
str
必要
e_tag
str
必要

這是不透明的字串。 您可以使用它來偵測作業是否已在要求之間變更。 特別是，您可以在更新作業時傳遞 ETag，以指定只有在沒有其他人同時修改作業時，您的變更才會生效。

last_modified
datetime
必要

這是作業層級資料上次變更的時間，例如作業狀態或優先順序。 它不會考慮工作層級變更，例如新增工作或工作變更狀態。

creation_time
datetime
必要
state
str 或 JobState
必要

作業的目前狀態。 可能的值包括：'active'、'disableing'、'disabled'、'enabling'、'terminating'、'completed'、'刪除'

state_transition_time
datetime
必要
previous_state
str 或 JobState
必要

作業的先前狀態。 如果作業處於初始作用中狀態，則不會設定這個屬性。 可能的值包括：'active'、'disableing'、'disabled'、'enabling'、'terminating'、'completed'、'刪除'

previous_state_transition_time
datetime
必要

如果作業處於初始作用中狀態，則不會設定這個屬性。

priority
int
必要

作業的優先順序。 優先順序值的範圍從 -1000 到 1000，-1000 表示最低優先順序，1000 表示最高優先順序。 預設值為 0。

allow_task_preemption
bool
必要

此作業中的工作是否可以由其他高優先順序工作先占。 如果此值設定為 True，則提交至系統的其他高優先順序工作會優先，而且能夠從此作業重新排入佇列工作。 使用更新作業 API 建立作業之後，您可以更新作業的 allowTaskPreemption。

max_parallel_tasks
int
必要

工作可以平行執行的工作數目上限。 如果指定 maxParallelTasks 的值必須是 -1 或大於 0。 如果未指定，預設值為 -1，這表示一次可以執行的工作數目沒有限制。 您可以使用更新作業 API 建立作業之後，更新作業的 maxParallelTasks。 預設值：-1 。

constraints
JobConstraints
必要

作業的執行條件約束。

job_manager_task
JobManagerTask
必要

啟動作業時要啟動之作業管理員工作的詳細資料。

job_preparation_task
JobPreparationTask
必要

作業準備工作。 作業準備工作是在作業的任何其他工作之前，在每個計算節點上執行的特殊工作。

job_release_task
JobReleaseTask
必要

作業發行工作。 作業發行工作是在每個執行作業之其他工作之計算節點上，于作業結束時執行的特殊工作。

common_environment_settings
list[EnvironmentSetting]
必要

個別工作可以藉由使用不同的值來指定相同的設定名稱，來覆寫此處指定的環境設定。

pool_info
PoolInformation
必要

與作業相關聯的集區設定。

on_all_tasks_complete
str 或 OnAllTasksComplete
必要

當作業中的所有工作都處於已完成狀態時，Batch 服務應該採取的動作。 預設值為 noaction。 可能的值包括：'noAction'、'terminateJob'

on_task_failure
str 或 OnTaskFailure
必要

當作業中的任何工作失敗時，Batch 服務應該採取的動作。 如果 失敗Info，工作會被視為失敗。 如果 Task 在用完重試計數之後使用非零結束代碼完成，或是啟動 Task 時發生錯誤，例如資源檔下載錯誤，則會設定 failureInfo。 預設值為 noaction。 可能的值包括：'noAction'、'performExitOptionsJobAction'

network_configuration
JobNetworkConfiguration
必要

作業的網路組態。

metadata
list[MetadataItem]
必要

Batch 服務不會將任何意義指派給中繼資料;它僅供使用者程式碼使用。

execution_info
JobExecutionInformation
必要

作業的執行資訊。

stats
JobStatistics
必要

作業整個存留期的資源使用量統計資料。 只有在使用包含 'stats' 屬性的 expand 子句擷取 CloudJob 時，才會填入此屬性;否則為 null。 統計資料可能無法立即使用。 Batch 服務會定期匯總統計資料。 典型的延遲大約是 30 分鐘。

方法

as_dict

使用 json.dump 傳回可以是 JSONify 的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。

傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。

請參閱此檔案中的三個範例：

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。
deserialize

使用 RestAPI 語法剖析 str 並傳回模型。
enable_additional_properties_sending
from_dict

使用指定的金鑰擷取器剖析聽寫會傳回模型。

根據預設，請考慮金鑰擷取器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

傳回會從此模型傳送至 Azure 的 JSON。

這是 as_dict (full_restapi_key_transformer別名，keep_readonly=False) 。

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。
validate

以遞迴方式驗證此模型，並傳回 ValidationError 的清單。

as_dict

使用 json.dump 傳回可以是 JSONify 的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。

傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。

請參閱此檔案中的三個範例：

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

參數

key_transformer
<xref:function>

金鑰轉換器函式。

keep_readonly
預設值: True

傳回

與聽寫 JSON 相容的物件

傳回類型

dict

deserialize

使用 RestAPI 語法剖析 str 並傳回模型。

deserialize(data, content_type=None)

參數

data
str
必要

使用 RestAPI 結構的 str。 JSON 預設為 。

content_type
str
預設值: None

JSON 預設會設定 application/xml if XML。

傳回

此模型的實例

例外狀況

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

使用指定的金鑰擷取器剖析聽寫會傳回模型。

根據預設，請考慮金鑰擷取器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor) 

from_dict(data, key_extractors=None, content_type=None)

參數

data
dict
必要

使用 RestAPI 結構的聽寫

content_type
str
預設值: None

JSON 預設會設定 application/xml if XML。

key_extractors
預設值: None

傳回

此模型的實例

例外狀況

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

傳回會從此模型傳送至 Azure 的 JSON。

這是 as_dict (full_restapi_key_transformer別名，keep_readonly=False) 。

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。

serialize(keep_readonly=False, **kwargs)

參數

keep_readonly
bool
預設值: False

如果您想要序列化唯讀屬性

傳回

與聽寫 JSON 相容的物件

傳回類型

dict

validate

以遞迴方式驗證此模型，並傳回 ValidationError 的清單。

validate()

傳回

驗證錯誤清單

傳回類型

list