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

TaskOperations 类

TaskOperations 操作。

不应直接实例化此类，而应创建一个客户端实例，该实例将为你创建它并将其附加为属性。

继承

builtins.object

TaskOperations

构造函数

TaskOperations(client, config, serializer, deserializer)

参数

client

必需

服务请求的客户端。

config

必需

服务客户端的配置。

serializer

必需

对象模型序列化程序。

deserializer

必需

对象模型反序列化程序。

变量

api_version

要用于请求的 API 版本。 常量值：“2023-05-01.17.0”。

方法

add	将任务添加到指定的作业。 任务从添加到完成的最长生存期为 180 天。 如果任务在添加后的 180 天内尚未完成，Batch 服务将终止该任务，并保留其当时处于的任何状态。
add_collection	将任务的集合添加到指定的作业。 请注意，每个任务必须具有唯一的 ID。 Batch 服务可能不会以在此请求中提交任务的顺序返回每个任务的结果。 如果服务器在请求期间超时或连接关闭，则请求可能已部分或完全处理，或者根本不处理。 在这种情况下，用户应该重新发出该请求。 请注意，重新发出请求时，用户应正确处理故障。 例如，在重试期间应使用相同的任务 ID，以便如果前面的操作成功，重试不会意外创建额外的任务。 如果响应包含任何无法添加的任务，客户端可以重试请求。 在重试中，最高效的是仅重新提交未能添加的任务，并省略第一次尝试时已成功添加的任务。 任务从添加到完成的最长生存期为 180 天。 如果任务在添加后的 180 天内尚未完成，Batch 服务将终止该任务，并保留其当时处于的任何状态。
delete	从指定的作业中删除任务。 删除任务时，无论保留时间) 如何，任务在运行它的计算节点上的目录中的所有文件也会 (被删除。 对于多实例任务，删除任务操作同步应用于主任务;子任务及其文件随后在后台异步删除。
get	获取有关指定任务的信息。 对于多实例任务，affinityId、executionInfo 和 nodeInfo 等信息引用主任务。 使用列表子任务 API 检索有关子任务的信息。
list	列出与指定作业关联的所有任务。 对于多实例任务，affinityId、executionInfo 和 nodeInfo 等信息引用主任务。 使用列表子任务 API 检索有关子任务的信息。
list_subtasks	列出与指定的多实例任务关联的所有子任务。 如果 Task 不是多实例 Task，则返回空集合。
reactivate	重新激活任务，即使其重试计数已用尽，也允许它再次运行。 重新激活使任务有资格再次重试，最大重试计数上限。 任务的状态更改为活动状态。 由于任务不再处于已完成状态，因此重新激活后，任何以前的退出代码或失败信息都不再可用。 每次重新激活 Task 时，其重试计数都将重置为 0。 对于未完成或以前成功完成的任务， (退出代码为 0) ，重新激活将失败。 此外，如果作业已完成 (，或者正在终止或删除) ，则它将失败。
terminate	终止指定的任务。 当任务已终止时，它将移动到已完成状态。 对于多实例任务，终止任务操作同步应用于主任务;子任务随后在后台异步终止。
update	汇报指定 Task 的属性。

add

将任务添加到指定的作业。

任务从添加到完成的最长生存期为 180 天。 如果任务在添加后的 180 天内尚未完成，Batch 服务将终止该任务，并保留其当时处于的任何状态。

add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_id

str

必需

任务要添加到的作业的 ID。

task

TaskAddParameter

必需

要添加的任务。

task_add_options

TaskAddOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

add_collection

将任务的集合添加到指定的作业。

请注意，每个任务必须具有唯一的 ID。 Batch 服务可能不会以在此请求中提交任务的顺序返回每个任务的结果。 如果服务器在请求期间超时或连接关闭，则请求可能已部分或完全处理，或者根本不处理。 在这种情况下，用户应该重新发出该请求。 请注意，重新发出请求时，用户应正确处理故障。 例如，在重试期间应使用相同的任务 ID，以便如果前面的操作成功，重试不会意外创建额外的任务。 如果响应包含任何无法添加的任务，客户端可以重试请求。 在重试中，最高效的是仅重新提交未能添加的任务，并省略第一次尝试时已成功添加的任务。 任务从添加到完成的最长生存期为 180 天。 如果任务在添加后的 180 天内尚未完成，Batch 服务将终止该任务，并保留其当时处于的任何状态。

add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)

参数

job_id

str

必需

要向其添加任务集合的作业的 ID。

value

list of TaskAddParameter

必需

要添加的任务集合。 此集合的总序列化大小必须小于 4MB。 如果它大于 4MB (例如，如果每个任务) 有 100 个资源文件或环境变量，则请求将失败并显示代码“RequestBodyTooLarge”，并且应以更少的任务重试。

task_add_collection_options

TaskAddCollectionOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

threads

int

默认值: 0

添加任务时要并行使用的线程数。 如果指定且大于 0，将启动其他线程以提交请求并等待它们完成。 否则，将在main线程上按顺序提交add_collection请求

返回

TaskAddCollectionResult如果 raw=true，则为ClientRawResponse

返回类型

TaskAddCollectionResult,

ClientRawResponse

例外

azure.batch.custom.CreateTasksErrorException

delete

从指定的作业中删除任务。

删除任务时，无论保留时间) 如何，任务在运行它的计算节点上的目录中的所有文件也会 (被删除。 对于多实例任务，删除任务操作同步应用于主任务;子任务及其文件随后在后台异步删除。

delete(job_id, task_id, task_delete_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_id

str

必需

要从中删除任务的作业的 ID。

task_id

str

必需

要删除的任务的 ID。

task_delete_options

TaskDeleteOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

get

获取有关指定任务的信息。

对于多实例任务，affinityId、executionInfo 和 nodeInfo 等信息引用主任务。 使用列表子任务 API 检索有关子任务的信息。

get(job_id, task_id, task_get_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_id

str

必需

包含任务的作业的 ID。

task_id

str

必需

要获取相关信息的任务的 ID。

task_get_options

TaskGetOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则 CloudTask 或 ClientRawResponse

返回类型

CloudTask,

ClientRawResponse

例外

BatchErrorException

list

列出与指定作业关联的所有任务。

对于多实例任务，affinityId、executionInfo 和 nodeInfo 等信息引用主任务。 使用列表子任务 API 检索有关子任务的信息。

list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_id

str

必需

作业的 ID。

task_list_options

TaskListOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

CloudTask 实例等迭代器

返回类型

CloudTaskPaged[CloudTask]

例外

BatchErrorException

list_subtasks

列出与指定的多实例任务关联的所有子任务。

如果 Task 不是多实例 Task，则返回空集合。

list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_id

str

必需

作业的 ID。

task_id

str

必需

任务的 ID。

task_list_subtasks_options

TaskListSubtasksOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则 CloudTaskListSubtasksResult 或 ClientRawResponse

返回类型

CloudTaskListSubtasksResult,

ClientRawResponse

例外

BatchErrorException

reactivate

重新激活任务，即使其重试计数已用尽，也允许它再次运行。

重新激活使任务有资格再次重试，最大重试计数上限。 任务的状态更改为活动状态。 由于任务不再处于已完成状态，因此重新激活后，任何以前的退出代码或失败信息都不再可用。 每次重新激活 Task 时，其重试计数都将重置为 0。 对于未完成或以前成功完成的任务， (退出代码为 0) ，重新激活将失败。 此外，如果作业已完成 (，或者正在终止或删除) ，则它将失败。

reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_id

str

必需

包含任务的作业的 ID。

task_id

str

必需

要重新激活的任务的 ID。

task_reactivate_options

TaskReactivateOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

terminate

终止指定的任务。

当任务已终止时，它将移动到已完成状态。 对于多实例任务，终止任务操作同步应用于主任务;子任务随后在后台异步终止。

terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_id

str

必需

包含任务的作业的 ID。

task_id

str

必需

要终止的任务的 ID。

task_terminate_options

TaskTerminateOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

update

汇报指定 Task 的属性。

update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_id

str

必需

包含任务的作业的 ID。

task_id

str

必需

要更新的任务的 ID。

constraints

TaskConstraints

默认值: None

适用于此任务的约束。 如果省略，则为 Task 提供默认约束。 对于多实例任务，更新保留时间仅适用于主任务，而不适用于子任务。

task_update_options

TaskUpdateOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

返回直接响应以及反序列化的响应

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

属性

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>