Unregister-ScheduledJob

参考

模块:: PSScheduledJob

删除本地计算机上的计划作业。

语法

Unregister-ScheduledJob
          [-InputObject] <ScheduledJobDefinition[]>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Unregister-ScheduledJob
          [-Id] <Int32[]>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Unregister-ScheduledJob
          [-Name] <String[]>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

说明

Unregister-ScheduledJob cmdlet 从本地计算机中删除计划作业。

当它删除或注销某个计划作业时，Unregister-ScheduledJob 将删除该计划作业的目录（位于 $HOME\AppData\Local\Microsoft\Windows\PowerShell\ScheduledJobs directory 中），其中包括定义了该计划作业的 XML 文件、作业执行历史记录以及所有作业结果。此操作还将删除任务计划程序中的作业。

Unregister-ScheduledJob 仅删除通过使用 Register-ScheduledJob cmdlet 创建的计划作业。它不会删除在任务计划程序中创建的计划作业。

你可以使用 Unregister-ScheduledJob 的参数按 ID 或名称删除计划作业，或者通过管道将计划作业从 Get-ScheduledJob 发送到 Unregister-ScheduledJob。

Unregister-ScheduledJob 是 PSScheduledJob 模块（包含在 Windows PowerShell 中）中的一系列作业计划 cmdlet 之一。

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

此 cmdlet 是在 Windows PowerShell 3.0 中引入的。

示例

示例 1：删除计划作业

Unregister-ScheduledJob TestJob

此命令删除本地计算机上的 TestJob 计划作业。

示例 2：删除所有计划作业

Get-ScheduledJob | Unregister-ScheduledJob -Force
Unregister-ScheduledJob -Name "*" -Force

此示例显示了可删除本地计算机上所有计划作业的两个不同命令。

第一个命令使用 Get-ScheduledJob cmdlet 获取本地计算机上的所有计划作业。管道运算符 (|) 将这些计划作业发送到 Unregister-ScheduleJob，后者将删除这些作业。

第二个命令使用 Unregister-ScheduledJob 的值为“所有”(*) 的 Name 参数来删除所有计划作业。

这两个命令都使用 Force 参数，该参数可删除计划作业，即使该作业的实例正在运行也是如此。

示例 3：删除远程计算机上的计划作业

Invoke-Command -ComputerName "Server01" { Unregister-ScheduledJob -Name "Test*"}

此命令将删除 Server01 远程计算机上其名称以 Test 开头的计划作业。该命令使用 Invoke-Command cmdlet 对 Server02 计算机运行 Unregister-ScheduledJob 命令。

参数

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:	SwitchParameter
别名:	cf
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

-Force

删除计划作业，即使该作业的实例正在运行也是如此。默认情况下，Unregister-ScheduledJob 不会中断正在运行的作业。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Id

删除具有指定标识号 (ID) 的计划作业。在计算机上输入计划作业的 ID。

类型:	Int32[]
Position:	0
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-InputObject

指定计划作业。请输入包含 ScheduledJob 对象的变量，或者键入获取 ScheduledJob 对象的命令或表达式，例如 Get-ScheduledJob 命令。还可以通过管道将 ScheduledJob 对象传递给 Unregister-JobTrigger。

类型:	ScheduledJobDefinition[]
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Name

删除具有指定名称的计划作业。在计算机上输入一个或多个计划作业的名称。支持通配符。

类型:	String[]
Position:	0
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:	SwitchParameter
别名:	wi
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

输入

ScheduledJobDefinition

你可以通过管道将计划作业传递给此 cmdlet。

输出

None

此 cmdlet 不返回任何输出。

通过