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

StartTask 类

  • 参考

当节点加入Azure Batch服务中的池时，或者在重新启动或重置计算节点映像时运行的任务。

在节点上触发恢复操作时，Batch 将重试任务。 恢复操作的示例包括 (但不限于在重新启动不正常的节点或计算节点因主机故障而消失时) 。 由于恢复操作而导致的重试独立于 ，并且不计入 maxTaskRetryCount。 即使 maxTaskRetryCount 为 0，也可能由于恢复操作而发生内部重试。 因此，所有任务都应是幂等的。 这意味着任务需要容忍中断和重启，而不会导致任何损坏或重复数据。 长时间运行的任务的最佳做法是使用某种形式的检查点。 在某些情况下，即使计算节点未重新启动，StartTask 也可能重新运行。 应特别注意避免 StartTask 创建分离进程或从 StartTask 工作目录安装/启动服务，因为这会阻止 Batch 重新运行 StartTask。

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

继承
Model
StartTask

构造函数

StartTask(*, command_line: str, container_settings=None, resource_files=None, environment_settings=None, user_identity=None, max_task_retry_count: int = None, wait_for_success: bool = None, **kwargs)

参数

command_line
str
必需

必需。 命令行不在 shell 下运行，因此无法利用 shell 功能，例如环境变量扩展。 如果要利用此类功能，则应在命令行中调用 shell，例如在 Windows 中使用“cmd /c MyCommand”或在 Linux 中使用“/bin/sh -c MyCommand”。 如果命令行引用文件路径，则应使用相对于 Task 工作目录) (相对路径，或使用 Batch 提供的环境变量 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) 。

container_settings
TaskContainerSettings
必需

运行 StartTask 的容器的设置。 指定此项后，AZ_BATCH_NODE_ROOT_DIR (节点上 Azure Batch) 目录的根目录以递归方式映射到容器中，所有 Task 环境变量都映射到容器中，并在容器中执行 Task 命令行。 AZ_BATCH_NODE_ROOT_DIR 之外的容器中生成的文件可能不会反映在主机磁盘上，这意味着 Batch 文件 API 无法访问这些文件。

resource_files
list[ResourceFile]
必需

此元素下列出的文件位于任务的工作目录中。

environment_settings
list[EnvironmentSetting]
必需
user_identity
UserIdentity
必需

运行 StartTask 时所依据的用户标识。 如果省略，则任务将作为 Task 唯一的非管理用户运行。

max_task_retry_count
int
必需

可以重试 Task 的最大次数。 如果任务退出代码不为零，Batch 服务会重试该任务。 请注意，此值专门用于控制重试的次数。 Batch 服务将尝试一次任务，然后可能会重试到此限制。 例如，如果最大重试计数为 3 次，则 Batch (一次初始尝试和 3 次重试) 最多尝试任务 4 次。 如果最大重试计数为 0，Batch 服务不会重试 Task。 如果最大重试计数为 -1，Batch 服务将无限制地重试任务，但不建议对启动任务或任何任务执行此操作。 默认值为 0（不重试）。

wait_for_success
bool
必需

Batch 服务是否应等待 StartTask 成功完成 (即退出代码为 0) 退出，然后再在计算节点上计划任何任务。 如果为 true，并且节点上的 StartTask 失败，Batch 服务将重试 StartTask 的最大重试次数 (maxTaskRetryCount) 。 如果所有重试后任务仍未成功完成，Batch 服务会将节点标记为不可用，并且不会计划任务到该节点。 可以通过计算节点状态和故障信息详细信息来检测此情况。 如果为 false，则 Batch 服务不会等待 StartTask 完成。 在这种情况下，当 StartTask 仍在运行时，其他任务可能会开始在计算节点上执行;即使 StartTask 失败，新任务也将继续在计算节点上进行计划。 默认值为 true。

方法

as_dict

使用 json.dump 返回可以是 JSONify 的 dict。

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

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

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

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

  • 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”。 Value 是此 对象中的当前值。

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

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

  • 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