你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

JobAddParameter 类

要添加的Azure Batch作业。

必须填充所有必需的参数才能发送到 Azure。

继承

Model

JobAddParameter

构造函数

JobAddParameter(*, id: str, pool_info, display_name: str = None, priority: int = None, max_parallel_tasks: int = -1, allow_task_preemption: bool = None, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, on_all_tasks_complete=None, on_task_failure=None, metadata=None, uses_task_dependencies: bool = None, network_configuration=None, **kwargs)

参数

id

str

必需

必需。 ID 可以包含字母数字字符（包括连字符和下划线）的任意组合，并且不能包含超过 64 个字符。 ID 是保留大小写且不区分大小写 (也就是说，帐户中可能没有两个 ID，这些 ID 仅因大小写) 而异。

display_name

str

必需

显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。

priority

int

必需

作业的优先级。 优先级值的范围为 -1000 到 1000，-1000 表示最低优先级，1000 表示最高优先级。 默认值为 0。

max_parallel_tasks

int

必需

可为作业并行执行的最大任务数。 maxParallelTasks 的值必须为 -1 或大于 0（如果指定）。 如果未指定，默认值为 -1，这意味着一次可以运行的任务数没有限制。 使用更新作业 API 创建作业后，可以更新该作业的 maxParallelTask。 默认值：-1 。

allow_task_preemption

bool

必需

此作业中的任务是否可以被其他高优先级作业抢占。 如果该值设置为 True，则提交到系统的其他高优先级作业将优先，并且能够从此作业重新排队任务。 使用更新作业 API 创建作业后，可以更新作业的 allowTaskPreemption。

constraints

JobConstraints

必需

作业的执行约束。

job_manager_task

JobManagerTask

必需

启动作业时要启动的作业管理器任务的详细信息。 如果作业未指定作业管理器任务，则用户必须将任务显式添加到作业。 如果作业指定了作业管理器任务，Batch 服务会在创建作业时创建作业管理器任务，并尝试在计划作业中的其他任务之前计划作业管理器任务。 作业管理器任务的典型用途是控制和/或监视作业执行，例如通过决定要运行的其他任务、确定工作何时完成等。 (但是，作业管理器任务并不局限于这些活动 - 它是系统中完全完善的任务，并执行 Job.) 例如，作业管理器任务可能会下载指定为参数的文件，分析该文件的内容，并根据这些内容提交其他任务。

job_preparation_task

JobPreparationTask

必需

作业准备任务。 如果作业具有作业准备任务，Batch 服务将在节点上运行作业准备任务，然后再在该计算节点上启动该作业的任何任务。

job_release_task

JobReleaseTask

必需

作业发布任务。 如果不同时指定作业的作业准备任务，则无法指定作业发布任务。 Batch 服务在运行作业准备任务的节点上运行作业发布任务。 作业发布任务的主要用途是撤消作业准备任务对计算节点所做的更改。 示例活动包括删除本地文件，或关闭在作业准备过程中启动的服务。

common_environment_settings

list[EnvironmentSetting]

必需

单个任务可以通过使用不同的值指定相同的设置名称来替代此处指定的环境设置。

pool_info

PoolInformation

必需

必需。 Batch 服务在其中运行作业任务的池。

on_all_tasks_complete

str 或 OnAllTasksComplete

必需

当作业中的所有任务都处于已完成状态时，Batch 服务应采取的操作。 请注意，如果作业不包含任何任务，则所有任务都被视为已完成。 因此，此选项最常用于作业管理器任务;如果要在没有作业管理器的情况下使用自动作业终止，则最初应将 onAllTasksComplete 设置为 noaction，并在添加完任务后将作业属性更新为 onAllTasksComplete 设置为 terminatejob。 默认值为 noaction。 可能的值包括：“noAction”、“terminateJob”

on_task_failure

str 或 OnTaskFailure

必需

当作业中的任何任务失败时，Batch 服务应采取的操作。 如果存在 failureInfo，则任务被视为失败。 如果任务在重试计数耗尽后以非零退出代码完成，或者如果启动 Task 时出错（例如由于资源文件下载错误），则会设置 failureInfo。 默认值为 noaction。 可能的值包括：“noAction”、“performExitOptionsJobAction”

metadata

list[MetadataItem]

必需

Batch 服务不赋予元数据任何含义;它仅用于使用用户代码。

uses_task_dependencies

bool

必需

作业中的任务是否可以定义彼此的依赖关系。 默认值为 false。

network_configuration

JobNetworkConfiguration

必需

作业的网络配置。

方法

as_dict	返回可以使用 json.dump 的 JSONify 的 dict。 高级用法可以选择使用回调作为参数： Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码键的“key”。 值是此对象中的当前值。 返回的字符串将用于序列化密钥。 如果返回类型是列表，则这被视为分层结果听写。 请参阅此文件中的三个示例： attribute_transformer full_restapi_key_transformer last_restapi_key_transformer 如果需要 XML 序列化，可以传递 kwargs is_xml=True。
deserialize	使用 RestAPI 语法分析 str 并返回模型。
enable_additional_properties_sending
from_dict	使用给定的键提取程序分析 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 的 dict。

高级用法可以选择使用回调作为参数：

Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码键的“key”。 值是此对象中的当前值。

返回的字符串将用于序列化密钥。 如果返回类型是列表，则这被视为分层结果听写。

请参阅此文件中的三个示例：

• 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

返回

与 dict JSON 兼容的对象

返回类型

dict

deserialize

使用 RestAPI 语法分析 str 并返回模型。

deserialize(data, content_type=None)

参数

data

str

必需

使用 RestAPI 结构的 str。 默认情况下为 JSON。

content_type

str

默认值: None

默认情况下，如果 XML，则设置 application/xml。

返回

此模型的实例

例外

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

使用给定的键提取程序分析 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 结构的 dict

content_type

str

默认值: None

默认情况下，如果 XML，则设置 application/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

如果要序列化只读属性

返回

与 dict JSON 兼容的对象

返回类型

dict

validate

以递归方式验证此模型，并返回 ValidationError 列表。

validate()

返回

验证错误列表

返回类型

list