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

JobScheduleOperations 类

JobScheduleOperations 操作。

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

继承

builtins.object

JobScheduleOperations

构造函数

JobScheduleOperations(client, config, serializer, deserializer)

参数

client

必需

服务请求的客户端。

config

必需

服务客户端的配置。

serializer

必需

对象模型序列化程序。

deserializer

必需

对象模型反序列化程序。

变量

api_version

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

方法

add	将作业计划添加到指定的帐户。
delete	从指定的帐户中删除作业计划。 删除作业计划时，也会删除该计划下的所有作业和任务。 删除任务时，也会删除计算节点上的工作目录中的所有文件， (保留期) 忽略。 删除作业计划后，将不再访问作业计划统计信息，尽管它们仍计入帐户生存期统计信息。
disable	禁用作业计划。 在再次启用作业计划之前，不会创建新作业。
enable	启用作业计划。
exists	检查指定的作业计划是否存在。
get	获取有关指定作业计划的信息。
list	列出指定帐户中的所有作业计划。
patch	汇报指定作业计划的属性。 这将仅替换请求中指定的作业计划属性。 例如，如果未使用此请求指定计划属性，则 Batch 服务将保留现有计划。 对作业计划的更改仅影响更新后计划创建的作业;当前运行的作业不受影响。
terminate	终止作业计划。
update	汇报指定作业计划的属性。 这将完全替换作业计划的所有可更新属性。 例如，如果未使用此请求指定计划属性，则 Batch 服务将删除现有计划。 对作业计划的更改仅影响更新后计划创建的作业;当前运行的作业不受影响。

add

将作业计划添加到指定的帐户。

add(cloud_job_schedule, job_schedule_add_options=None, custom_headers=None, raw=False, **operation_config)

参数

cloud_job_schedule

JobScheduleAddParameter

必需

要添加的作业计划。

job_schedule_add_options

JobScheduleAddOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

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

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

delete

从指定的帐户中删除作业计划。

删除作业计划时，也会删除该计划下的所有作业和任务。 删除任务时，也会删除计算节点上的工作目录中的所有文件， (保留期) 忽略。 删除作业计划后，将不再访问作业计划统计信息，尽管它们仍计入帐户生存期统计信息。

delete(job_schedule_id, job_schedule_delete_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_schedule_id

str

必需

要删除的作业计划的 ID。

job_schedule_delete_options

JobScheduleDeleteOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

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

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

disable

禁用作业计划。

在再次启用作业计划之前，不会创建新作业。

disable(job_schedule_id, job_schedule_disable_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_schedule_id

str

必需

要禁用的作业计划的 ID。

job_schedule_disable_options

JobScheduleDisableOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

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

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

enable

启用作业计划。

enable(job_schedule_id, job_schedule_enable_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_schedule_id

str

必需

要启用的作业计划的 ID。

job_schedule_enable_options

JobScheduleEnableOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

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

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

exists

检查指定的作业计划是否存在。

exists(job_schedule_id, job_schedule_exists_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_schedule_id

str

必需

要检查的作业计划的 ID。

job_schedule_exists_options

JobScheduleExistsOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

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

operation_config

必需

操作配置替代。

返回

bool 或 ClientRawResponse（如果 raw=true）

返回类型

bool,

ClientRawResponse

例外

BatchErrorException

get

获取有关指定作业计划的信息。

get(job_schedule_id, job_schedule_get_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_schedule_id

str

必需

要获取的作业计划的 ID。

job_schedule_get_options

JobScheduleGetOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

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

operation_config

必需

操作配置替代。

返回

如果 raw=true，则 CloudJobSchedule 或 ClientRawResponse

返回类型

CloudJobSchedule,

ClientRawResponse

例外

BatchErrorException

list

列出指定帐户中的所有作业计划。

list(job_schedule_list_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_schedule_list_options

JobScheduleListOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

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

operation_config

必需

操作配置替代。

返回

CloudJobSchedule 实例等迭代器

返回类型

CloudJobSchedulePaged[CloudJobSchedule]

例外

BatchErrorException

patch

汇报指定作业计划的属性。

这将仅替换请求中指定的作业计划属性。 例如，如果未使用此请求指定计划属性，则 Batch 服务将保留现有计划。 对作业计划的更改仅影响更新后计划创建的作业;当前运行的作业不受影响。

patch(job_schedule_id, job_schedule_patch_parameter, job_schedule_patch_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_schedule_id

str

必需

要更新的作业计划的 ID。

job_schedule_patch_parameter

JobSchedulePatchParameter

必需

请求的参数。

job_schedule_patch_options

JobSchedulePatchOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

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

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

terminate

终止作业计划。

terminate(job_schedule_id, job_schedule_terminate_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_schedule_id

str

必需

要终止的作业计划的 ID。

job_schedule_terminate_options

JobScheduleTerminateOptions

默认值: None

操作的其他参数

custom_headers

dict

默认值: None

将添加到请求的标头

raw

bool

默认值: False

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

operation_config

必需

操作配置替代。

返回

如果 raw=true，则为 None 或 ClientRawResponse

返回类型

None,

ClientRawResponse

例外

BatchErrorException

update

汇报指定作业计划的属性。

这将完全替换作业计划的所有可更新属性。 例如，如果未使用此请求指定计划属性，则 Batch 服务将删除现有计划。 对作业计划的更改仅影响更新后计划创建的作业;当前运行的作业不受影响。

update(job_schedule_id, job_schedule_update_parameter, job_schedule_update_options=None, custom_headers=None, raw=False, **operation_config)

参数

job_schedule_id

str

必需

要更新的作业计划的 ID。

job_schedule_update_parameter

JobScheduleUpdateParameter

必需

请求的参数。

job_schedule_update_options

JobScheduleUpdateOptions

默认值: 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'>