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

JobSchedule 类

用于管理作业计划的类。

继承
azure.ai.ml.entities._mixins.RestTranslatableMixin
JobSchedule
azure.ai.ml.entities._schedule.schedule.Schedule
JobSchedule
azure.ai.ml.entities._mixins.TelemetryMixin
JobSchedule

构造函数

JobSchedule(*, name: str, trigger: CronTrigger | RecurrenceTrigger, create_job: Job | str, display_name: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, **kwargs)

参数

name
str

计划的名称。

trigger
Union[CronTrigger, RecurrenceTrigger]

计划的触发器配置。

create_job
Union[Job, str]

作业定义或现有作业名称。

display_name
Optional[str]

计划的显示名称。

description
Optional[str]

计划的说明。

tags
Optional[dict[str, str]]

标记字典。 可以添加、删除和更新标记。

properties
Optional[dict[str, str]]

要与计划关联的属性字典。

示例

配置 JobSchedule。


   from azure.ai.ml import load_job
   from azure.ai.ml.entities import JobSchedule, RecurrencePattern, RecurrenceTrigger

   pipeline_job = load_job("./sdk/ml/azure-ai-ml/tests/test_configs/command_job/command_job_test_local_env.yml")
   trigger = RecurrenceTrigger(
       frequency="week",
       interval=4,
       schedule=RecurrencePattern(hours=10, minutes=15, week_days=["Monday", "Tuesday"]),
       start_time="2023-03-10",
   )
   job_schedule = JobSchedule(name="simple_sdk_create_schedule", trigger=trigger, create_job=pipeline_job)

方法

dump

将计划内容转储到 YAML 格式的文件中。

dump

将计划内容转储到 YAML 格式的文件中。

dump(dest: str | PathLike | IO, **kwargs) -> None

参数

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
必需

要向其写入 YAML 内容的本地路径或文件流。 如果 dest 是文件路径,则将创建新文件。 如果 dest 是一个打开的文件,则该文件将直接写入。

kwargs
dict

要传递给 YAML 序列化程序的其他参数。

例外

如果 dest 是文件路径且文件已存在,则引发。

如果 dest 是打开的文件且文件不可写,则引发。

属性

base_path

资源的基路径。

返回

资源的基路径。

返回类型

str

create_job

返回与计划关联的作业。

返回

作业定义或现有作业名称。

返回类型

creation_context

资源的创建上下文。

返回

资源的创建元数据。

返回类型

id

资源 ID。

返回

资源的全局 ID、Azure 资源管理器 (ARM) ID。

返回类型

is_enabled

指定是否启用计划。

返回

如果启用了计划,则为 True;否则为 False。

返回类型

provisioning_state

返回计划的预配状态。 可能的值包括“创建”、“更新”、“删除”、“成功”、“失败”、“取消”。

返回

计划的预配状态。

返回类型

str

type

计划类型。 接受的值为“job”和“monitor”。

返回

计划类型。

返回类型

str