Set-ScheduledJob

Set-ScheduledJob
    [-InputObject] <ScheduledJobDefinition>
    [-Name <String>]
    [-ScriptBlock <ScriptBlock>]
    [-Trigger <ScheduledJobTrigger[]>]
    [-InitializationScript <ScriptBlock>]
    [-RunAs32]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-ScheduledJobOption <ScheduledJobOptions>]
    [-MaxResultCount <Int32>]
    [-PassThru]
    [-ArgumentList <Object[]>]
    [-RunNow]
    [-RunEvery <TimeSpan>]
    [<CommonParameters>]

Set-ScheduledJob
    [-InputObject] <ScheduledJobDefinition>
    [-Name <String>]
    [-FilePath <String>]
    [-Trigger <ScheduledJobTrigger[]>]
    [-InitializationScript <ScriptBlock>]
    [-RunAs32]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-ScheduledJobOption <ScheduledJobOptions>]
    [-MaxResultCount <Int32>]
    [-PassThru]
    [-ArgumentList <Object[]>]
    [-RunNow]
    [-RunEvery <TimeSpan>]
    [<CommonParameters>]

Set-ScheduledJob
    [-InputObject] <ScheduledJobDefinition>
    [-ClearExecutionHistory]
    [-PassThru]
    [<CommonParameters>]

Set-ScheduledJob cmdlet 更改计划作业的属性，例如作业运行的命令或运行作业所需的凭据。 还可以使用它清除计划作业的执行历史记录。

若要使用此 cmdlet，请首先使用 Get-ScheduledJob cmdlet 获取计划作业。 然后，通过管道将计划作业传递给 Set-ScheduledJob ，或将作业保存在变量中，并使用 InputObject 参数来标识作业。 使用 Set-ScheduledJob 的剩余参数更改作业属性或清除执行历史记录。

尽管可以使用 Set-ScheduledJob 更改计划的作业的触发器和选项，但 Add-JobTrigger、Set-JobTrigger 和 Set-ScheduledJobOption cmdlet 提供了更轻松的方法来完成这些任务。 若要创建新的计划作业，请使用 Register-ScheduledJob cmdlet。

Set-ScheduledJob 的 Trigger 参数添加一个或多个启动作业的作业触发器。 触发器 参数是可选的，因此可以在创建计划作业时添加触发器，稍后添加作业触发器，添加 RunNow 参数以立即启动作业，使用 Start-Job cmdlet 随时启动作业，或将未触发的计划作业保存为其他作业的模板。

Set-ScheduledJob 是 WINDOWS PowerShell 中包含的 PSScheduledJob 模块中作业计划 cmdlet 的集合之一。

有关计划作业的详细信息，请参阅 PSScheduledJob 模块中的“关于”主题。 导入 PSScheduledJob 模块，然后键入：Get-Help about_Scheduled* 或查看about_Scheduled_Jobs。

此 cmdlet 已在 Windows PowerShell 3.0 中引入。

PS C:\> Get-ScheduledJob -Name "Inventory"
Id         Name            Triggers        Command                                  Enabled
--         ----            --------        -------                                  -------
1          Inventory       {1}             C:\Scripts\Get-Inventory.ps1             True

The second command uses the Get-ScheduledJob cmdlet to get the Inventory scheduled job. A pipeline operator (|) sends the scheduled job to the **Set-ScheduledJob** cmdlet. The **Set-ScheduledJob** cmdlet uses the *Script* parameter to specify a new script, Get-FullInventory.ps1. The command uses the *Passthru* parameter to return the scheduled job after the change.
PS C:\> Get-ScheduledJob -Name "Inventory" | Set-ScheduledJob -FilePath "C:\Scripts\Get-FullInventory.ps1" -Passthru
Id         Name            Triggers        Command                                  Enabled
--         ----            --------        -------                                  -------
1          Inventory       {1}             C:\Scripts\Get-FullInventory.ps1         True

此示例演示如何更改在计划作业中运行的脚本。

第一个命令使用 Get-ScheduledJob cmdlet 获取清单计划作业。 此输出显示该作业运行 Get-Inventory.ps1 脚本。

此命令不是必需的；包含它只是为了显示脚本更改的效果。

PS C:\> Get-ScheduledJob BackupArchive | Set-ScheduledJob -ClearExecutionHistory

此命令删除当前执行历史记录，并保存了 BackupArchive 计划作业的作业结果。

该命令使用 Get-ScheduledJob cmdlet 获取 BackupArchive 计划作业。 管道运算符 （|） 将作业发送到 Set-ScheduledJob cmdlet 以更改作业。 Set-ScheduledJob cmdlet 使用 ClearExecutionHistory 参数删除执行历史记录和保存的结果。

有关计划作业的执行历史记录和保存的作业结果的详细信息，请参阅about_Scheduled_Jobs。

PS C:\> Invoke-Command -Computer "Server01, Server02" -ScriptBlock {Get-ScheduledJob | Set-ScheduledJob -InitializationScript \\SrvA\Scripts\SetForRun.ps1}

此命令更改 Server01 和 Server02 计算机上所有计划作业中的初始化脚本。

该命令使用 Invoke-Command cmdlet 在 Server01 和 Server02 计算机上运行命令。

远程命令以获取计算机上的所有计划作业的 Get-ScheduledJob 命令开头。 计划的作业通过管道传输到 Set-ScheduledJob cmdlet，该 cmdlet 将初始化脚本更改为 SetForRun.ps1。

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

可以通过管道将计划作业传递给 Set-ScheduledJob。

如果使用 Passthru 参数，Set-ScheduledJob 将返回已更改的计划作业。 否则，此 cmdlet 不会生成任何输出。