Get-ScheduledJob

获取本地计算机上的计划作业。

语法

DefinitionId (默认值)

Get-ScheduledJob
    [[-Id] <Int32[]>]
    [<CommonParameters>]

DefinitionName

Get-ScheduledJob
    [-Name] <String[]>
    [<CommonParameters>]

说明

Get-ScheduledJob cmdlet 在本地计算机上获取计划作业。 Get-ScheduledJob 仅获取由当前用户使用 Register-ScheduledJob cmdlet 创建的计划作业。

尽管使用 Register-ScheduledJob cmdlet 创建的作业显示在任务计划程序中,Get-ScheduledJob 仅获取计划作业。 它不会获取在任务计划程序中创建的计划任务。

如果没有参数,Get-ScheduledJob 将获取计算机上的所有计划作业。 可以使用 Get-ScheduledJob 的参数按 ID 或名称获取计划作业,并检查作业或通过管道将其传递给其他 cmdlet。

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

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

此 cmdlet 已在 Windows PowerShell 3.0 中引入。

示例

示例 1:获取所有计划作业

PS C:\> Get-ScheduledJob

此命令获取本地计算机上的所有计划作业。

示例 2:按名称获取计划作业

PS C:\> Get-ScheduledJob -Name *Backup*, *Archive*

此命令获取计算机上包含备份或存档的名称的所有计划作业。 此命令格式允许搜索特定作业。

示例 3:获取远程计算机上的计划作业

PS C:\> Invoke-Command -ComputerName (Get-Content Servers.txt) {Get-ScheduledJob}

此命令获取 Servers.txt 文件中列出的计算机上的所有计划作业。 该命令使用 Invoke-Command cmdlet 在每台计算机上运行 Get-ScheduleJob 命令。

示例 4:将计划作业管道传递给其他 cmdlet

PS C:\> Get-ScheduledJob DailyBackup, WeeklyBackup | Get-JobTrigger

此命令获取 DailyBackup 和 WeeklyBackup 计划作业的作业触发器。 它使用 Get-ScheduledJob cmdlet 来获取计划的作业和 Get-JobTrigger cmdlet 来获取计划作业的作业触发器。

参数

-Id

仅获取具有指定标识号(ID)的计划作业。 在计算机上输入一个或多个计划的作业 ID。 默认情况下,Get-ScheduledJob 获取计算机上的所有计划作业。

参数属性

类型:

Int32[]

默认值:All jobs
支持通配符:False
不显示:False

参数集

DefinitionId
Position:0
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Name

仅获取具有指定名称的计划作业。 在计算机上输入一个或多个计划作业的名称。 支持通配符。 默认情况下,Get-ScheduledJob 获取计算机上的所有计划作业。

参数属性

类型:

String[]

默认值:All jobs
支持通配符:False
不显示:False

参数集

DefinitionName
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

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

输入

None

不能通过管道将输入传递给 Get-ScheduledJob

输出

ScheduledJobDefinition

备注

  • 每个计划作业都保存在本地计算机上的 $home\AppData\Local\Microsoft\Windows\PowerShell\ScheduledJobs 目录的子目录中。 子目录为计划作业命名,并包含计划作业的 XML 文件及其执行历史记录的记录。 有关磁盘上计划作业的详细信息,请参阅about_Scheduled_Jobs_Advanced。
  • 在 Windows PowerShell 中创建的计划作业显示在任务计划程序库\Microsoft\Windows\PowerShell\ScheduledJobs 文件夹中的任务计划程序中。 可以使用任务计划程序查看和编辑计划作业。
  • 可以使用任务计划程序、SchTasks.exe 命令行工具和任务计划程序 cmdlet 来管理使用计划作业 cmdlet 创建的计划作业。 但是,不能使用计划作业 cmdlet 来管理在任务计划程序中创建的任务。