Share via

ScheduleRecurrence 類別

  • 參考

定義管線 Schedule 的頻率、間隔和開始時間。

ScheduleRecurrence 也可讓您指定週期的時區和時數或分鐘或周數。

初始化排程週期。

它也允許指定時區，以及週期的時數或分鐘或周天。

繼承
builtins.object
ScheduleRecurrence

建構函式

ScheduleRecurrence(frequency, interval, start_time=None, time_zone=None, hours=None, minutes=None, week_days=None, time_of_day=None)

參數

frequency
str
必要

描述排程引發頻率的時間單位。 可以是 「Minute」、「Hour」、「Day」、「Week」 或 「Month」。

interval
int
必要

值，指定根據頻率引發排程的頻率，這是要等到排程再次引發的時間單位數目。

start_time
datetime 或 str
預設值: None

描述開始日期和時間的 datetime 物件。 datetime 物件的 tzinfo 應該是無，請視需要使用 time_zone 屬性來指定時區。 您也可以以下列格式將此參數指定為字串：YYYY-MM-DDThh：mm：ss。 如果未提供 None，則會立即執行第一個工作負載，而未來的工作負載會根據排程執行。 如果開始時間是過去的時間，則會在所計算的下一個執行時間執行第一個工作負載。

如果 start_time 符合 week_days 和 time_of_day (或 hours 和 和 minutes) ，則第一個工作負載不會在 執行 start_time ，而是會在下一個計算執行時間執行。

time_zone
TimeZone
預設值: None

指定 的 start_time 時區。 如果未提供 UTC，則會使用 None。

hours
list[int]
預設值: None

如果您針對頻率指定 「Day」 或 「Week」，則可以指定一或多個從 0 到 23 的整數，並以逗號分隔，做為您想要執行工作流程的當天時數。 例如，如果您指定 "10"、"12" 及 "14"，就會得出上午 10 點、下午 12 點及下午 2 點作為整點標記。 注意：只能 time_of_day 使用 或 hours 和 minutes 。

minutes
list[int]
預設值: None

如果您針對頻率指定 「Day」 或 「Week」，則可以指定一或多個從 0 到 59 的整數，並以逗號分隔，作為您想要執行工作流程的小時分鐘數。 例如，您可以指定 "30" 作為分鐘標記，然後使用上個範例代表一天中的整點，這樣就會得出上午 10:30、下午 12:30 及下午 2:30。 注意：只能 time_of_day 使用 或 hours 和 minutes 。

week_days
list[str]
預設值: None

如果您為頻率指定 「Week」，您可以指定一或多個以逗號分隔的天數，當您想要執行工作流程時：「Monday」、「Friday」、「Saturday」 和 「Sunday」。

time_of_day
str
預設值: None

如果您為頻率指定 「Day」 或 「Week」，您可以指定排程在 hh：mm 格式中以字串形式執行的時間。 例如，如果您指定 「15：30」，則排程會在下午 3：30 執行。 注意： only time_of_day 或 hours 和 minutes 可供使用。

frequency
str
必要

描述排程引發頻率的時間單位。 可以是 「Minute」、「Hour」、「Day」、「Week」 或 「Month」。

interval
int
必要

值，指定根據頻率引發排程的頻率，這是要等到排程再次引發的時間單位數目。

start_time
datetime 或 str
必要

描述開始日期和時間的 datetime 物件。 datetime 物件的 tzinfo 應該是無，請視需要使用 time_zone 屬性來指定時區。 也可以是此格式的字串：YYYY-MM-DDThh：mm：ss。 如果提供 None，則會立即執行第一個工作負載，而未來的工作負載會根據排程執行。 如果開始時間是過去的時間，則會在所計算的下一個執行時間執行第一個工作負載。

如果 start_time 符合 week_days 和 time_of_day (或 hours 和 和 minutes) ，則第一個工作負載不會在 執行 start_time ，而是會在下一個計算執行時間執行。

time_zone
TimeZone
必要

指定start_time的時區。 如果未提供 UTC，則會使用 None。

hours
list[int]
必要

如果您針對頻率指定 「Day」 或 「Week」，則可以指定一或多個從 0 到 23 的整數，並以逗號分隔，做為您想要執行工作流程的當天時數。 例如，如果您指定 "10"、"12" 及 "14"，就會得出上午 10 點、下午 12 點及下午 2 點作為整點標記。 注意：只能使用time_of_day或小時和分鐘數。

minutes
list[int]
必要

如果您針對頻率指定 「Day」 或 「Week」，則可以指定一或多個從 0 到 59 的整數，並以逗號分隔，作為您想要執行工作流程的小時分鐘數。 例如，您可以指定 "30" 作為分鐘標記，然後使用上個範例代表一天中的整點，這樣就會得出上午 10:30、下午 12:30 及下午 2:30。 注意：只能使用time_of_day或小時和分鐘數。

week_days
list[str]
必要

如果您為頻率指定 「Week」，您可以指定一或多個以逗號分隔的天數，當您想要執行工作流程時：「Monday」、「Friday」、「Saturday」 和 「Sunday」

time_of_day
str
必要

如果您為頻率指定 「Day」 或 「Week」，您可以指定排程在 hh：mm 格式中以字串形式執行的時間。 例如，如果您指定 「15：30」，則排程會在下午 3：30 執行。 注意：只能使用time_of_day或小時和分鐘數。

備註

建立管線的排程時，會使用 ScheduleRecurrence，如下所示：


   from azureml.pipeline.core import Schedule, ScheduleRecurrence

   recurrence = ScheduleRecurrence(frequency="Hour", interval=12)
   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id=pipeline.id,
                              experiment_name="experiment_name", recurrence=recurrence)

以下是有效 ScheduleRecurrences 的一些範例：


   from azureml.pipeline.core import ScheduleRecurrence

   # Submit the Pipeline every 15 minutes
   recurrence = ScheduleRecurrence(frequency="Minute", interval=15)
   # Submit the Pipeline every 2 weeks on Monday and Wednesday at 6:30pm UTC
   recurrence = ScheduleRecurrence(frequency="Week", interval=2, week_days=["Monday", "Wednesday"],
                                   time_of_day="18:30")
   # Submit the Pipeline on the first day of every month starting November 1, 2019 at 9AM
   recurrence = ScheduleRecurrence(frequency="Month", interval=1, start_time="2019-11-01T09:00:00")
   # Submit the Pipeline every hour on the 55th minute starting on January 13th, 2020 at 12:55pm
   # if the specified start time is in the past, the first workload is run at the next future 55th minute
   # of the hour.
   recurrence = ScheduleRecurrence(frequency="Hour", interval=1, start_time="2020-01-13T12:55:00")

方法

validate

驗證排程週期。

validate

驗證排程週期。

validate()