共用方式為

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 序列化程式的其他引數。

例外狀況

FileExistsError

如果 dest 是檔案路徑且檔案已經存在，則引發。

IOError

如果 dest 是開啟的檔案，而且無法寫入檔案，則引發。

屬性

base_path

資源的基底路徑。

傳回

資源的基底路徑。

傳回類型

str

create_job

傳回與排程相關聯的作業。

傳回

作業定義或現有的作業名稱。

傳回類型

Union[Job, str]

creation_context

資源的建立內容。

傳回

資源的建立中繼資料。

傳回類型

Optional[SystemData]

id

資源識別碼。

傳回

資源的全域識別碼，Azure Resource Manager (ARM) 識別碼。

傳回類型

Optional[str]

is_enabled

指定是否啟用排程。

傳回

如果啟用排程，則為 True，否則為 False。

傳回類型

bool

provisioning_state

傳回排程的布建狀態。 可能的值包括 「建立」、「更新」、「刪除」、「成功」、「失敗」、「已取消」。

傳回

排程的布建狀態。

傳回類型

str

type

排程類型。 接受的值是 'job' 和 'monitor'。

傳回

排程類型。

傳回類型

str