你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
JobOperations 类
JobOperations 操作。
不应直接实例化此类，而应创建一个客户端实例，该实例将为你创建该类并将其附加为属性。
- 继承
-
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 |
删除作业。 删除作业还会删除属于该作业的所有任务以及所有作业统计信息。 这还会覆盖任务数据的保留期;也就是说，如果作业包含仍保留在计算节点上的任务，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 |
汇报指定作业的属性。 这将仅替换请求中指定的作业属性。 例如，如果作业具有约束，并且请求未指定 constraints 元素，则 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
删除作业。
删除作业还会删除属于该作业的所有任务以及所有作业统计信息。 这还会覆盖任务数据的保留期;也就是说，如果作业包含仍保留在计算节点上的任务，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
操作配置替代。
返回
CloudJob 或 ClientRawResponse（如果 raw=true）
返回类型
例外
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
操作配置替代。
返回
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
操作配置替代。
返回
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
操作配置替代。
返回
一个迭代器，如 JobPreparationAndReleaseTaskExecutionInformation 的实例
返回类型
例外
patch
汇报指定作业的属性。
这将仅替换请求中指定的作业属性。 例如，如果作业具有约束，并且请求未指定 constraints 元素，则 Job 将保留现有约束。
patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
None 或 ClientRawResponse（如果 raw=true）
返回类型
例外
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
操作配置替代。
返回
None 或 ClientRawResponse（如果 raw=true）
返回类型
例外
update
汇报指定作业的属性。
这将完全替换作业的所有可更新属性。 例如，如果作业具有与其关联的约束，并且未使用此请求指定约束，则 Batch 服务将删除现有约束。
update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)参数
- operation_config
操作配置替代。
返回
None 或 ClientRawResponse（如果 raw=true）
返回类型
例外
属性
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>