New-ScheduledTaskTrigger
New-ScheduledTaskTrigger
Creates a scheduled task trigger object.
構文
Parameter Set: Once
New-ScheduledTaskTrigger [-Once] -At <DateTime> [-RandomDelay <TimeSpan> ] [-RepetitionDuration <TimeSpan> ] [-RepetitionInterval <TimeSpan> ] [ <CommonParameters>]
Parameter Set: AtLogon
New-ScheduledTaskTrigger [-AtLogOn] [-RandomDelay <TimeSpan> ] [-User <String> ] [ <CommonParameters>]
Parameter Set: AtStartup
New-ScheduledTaskTrigger [-AtStartup] [-RandomDelay <TimeSpan> ] [ <CommonParameters>]
Parameter Set: Daily
New-ScheduledTaskTrigger [-Daily] -At <DateTime> [-DaysInterval <Int32> ] [-RandomDelay <TimeSpan> ] [ <CommonParameters>]
Parameter Set: Weekly
New-ScheduledTaskTrigger [-Weekly] -At <DateTime> -DaysOfWeek {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}[] [-RandomDelay <TimeSpan> ] [-WeeksInterval <Int32> ] [ <CommonParameters>]
詳細説明
The New-ScheduledTaskTrigger cmdlet creates and returns a new scheduled task trigger object.
You can use a time-based trigger or an event-based trigger to start a task. Time-based triggers include starting a task at a specific time or starting a task multiple times on a daily or weekly schedule. Event-based triggers include starting a task when the system starts up or when a user logs on to the computer. Each task can contain one or more triggers, which means there are many ways that you can start a task. If a task has multiple triggers, Task Scheduler starts the task when any of the triggers occur.
パラメーター
-At<DateTime>
Specifies a date and time to trigger the task. This paramater is valid for calendar-based triggers (Once, Daily, Weekly).
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-AtLogOn
Indicates that a trigger starts a task when a user logs on.
エイリアス |
なし |
必須? |
true |
位置は? |
1 |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-AtStartup
Indicates that a trigger starts a task when the system is started.
エイリアス |
なし |
必須? |
true |
位置は? |
1 |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Daily
Indicates that a trigger starts a task on a recurring daily schedule.
エイリアス |
なし |
必須? |
true |
位置は? |
1 |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-DaysInterval<Int32>
Specifies the interval between the days in the schedule. An interval of 1 produces a daily schedule. An interval of 2 produces an every-other day schedule.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-DaysOfWeek<DayOfWeek[]>
Specifies an array of the days of the week on which Task Scheduler runs the task.
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
{ DayOfWeek.Monday, DayOfWeek.Tuesday, DayOfWeek.Wednesday, DayOfWeek.Thursday, DayOfWeek.Friday, DayOfWeek.Saturday, DayOfWeek.Sunday } |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Once
Indicates that a trigger starts a task once at a time specified in the At parameter.
エイリアス |
なし |
必須? |
true |
位置は? |
1 |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-RandomDelay<TimeSpan>
Specifies a random amount of time to delay the start time of the trigger. The delay time is a random time between the time the task triggers and the time that you specify in this setting.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
0 |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-RepetitionDuration<TimeSpan>
Specifies how long the repetition pattern repeats after the task starts.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-RepetitionInterval<TimeSpan>
Specifies an amount of time between each restart of the task. The task will run, wait for the time interval specified, and then run again. This cycle continues for the time that you specify for the RepetitionDuration parameter.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-User<String>
Specifies the identifier of the user for a trigger that starts a task when a user logs on.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Weekly
Indicates that the trigger starts a task on a recurring weekly schedule.
エイリアス |
なし |
必須? |
true |
位置は? |
1 |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WeeksInterval<Int32>
Specifies the interval between the weeks in the schedule. An interval of 1 produces a weekly schedule. An interval of 2 produces an every-other week schedule.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
- Microsoft.Management.Infrastructure.CimInstance#MSFT_TaskTrigger
例
Example 1: Register a scheduled task that starts a task once
This example registers a scheduled task that starts once.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.
PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts the task once at 3:00 A.M and assigns the ScheduledTaskTrigger object to the Stt variable.
PS C:\> $Stt = New-ScheduledTaskTrigger -Once -At 3am
The third command registers the scheduled task Task01 to run the task action named Cmd once at 3:00 A.M.
PS C:\> Register-ScheduledTask Task01 -Action $Sta -Trigger $Stt
Example 2: Register a scheduled task that starts every day
This example registers a scheduled task that starts every day.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.
PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts every day at 3:00 A.M and assigns the ScheduledTaskTrigger object to the Stt variable.
PS C:\> $Stt = New-ScheduledTaskTrigger -Daily -At 3am
The third command registers the scheduled task Task01 to run the task action named Cmd every day at 3:00 A.M.
PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stt
Example 3: Register a scheduled task that starts every 3 days
This example registers a scheduled task that starts every 3 days.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.
PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts every 3 days at 3:00 A.M and assigns the ScheduledTaskTrigger object to the Stt variable.
PS C:\> $Stt = New-ScheduledTaskTrigger -Daily -DaysInterval 3 -At 3am
The third command registers the scheduled task Task01 to run the task action named cmd every 3 days at 3:00 A.M.
PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stt
Example 4: Register a scheduled task that starts every-other week
This example registers a scheduled task that starts every other week.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.
PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts every other Sunday at 3:00 A.M and assigns the ScheduledTaskTrigger object to the Stt variable.
PS C:\> $Stt = New-ScheduledTaskTrigger -Weekly -WeeksInterval 2 -DaysOfWeek Sunday -At 3am
The third command registers the scheduled task Task01 to run the task action named Cmd every other Sunday at 3:00 A.M.
PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stt
Example 5: Register a scheduled task that starts when a user logs on
This example registers a scheduled task that starts when a user logs on.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.
PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts when a user logs on, and assigns the ScheduledTaskTrigger object to the Stt variable.
PS C:\> $Stt = New-ScheduledTaskTrigger -AtLogon
The third command registers the scheduled task Task01 to run the task action named Cmd when a user logs on.
PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stt