通过

Unregister-ScheduledJob

模块:
PSScheduledJob Module

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

语法

Definition (默认值) 

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

DefinitionId 

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

DefinitionName 

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

说明

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

删除或取消注册计划作业时，Unregister-ScheduledJob 删除计划作业的目录（在 $home\AppData\Local\Microsoft\Windows\PowerShell\ScheduledJobs 目录中），其中包含定义计划作业、作业执行历史记录和所有作业结果的 XML 文件。 此操作还会从任务计划程序中删除作业。

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

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

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

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

此 cmdlet 已在 Windows PowerShell 3.0 中引入。

示例

示例 1：删除计划作业

PS C:\> Unregister-ScheduledJob TestJob

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

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

PS C:\> Get-ScheduledJob | Unregister-ScheduledJob -Force
PS C:\> Unregister-ScheduledJob -Name "*" -Force

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

第一个命令使用 Get-ScheduledJob cmdlet 在本地计算机上获取所有计划作业。 管道运算符 （|） 将计划作业发送到 Unregister-ScheduleJob，这会删除它们。

第二个命令使用 Unregister-ScheduledJob 的 Name 参数，其值为 all = 删除所有计划作业。

这两个命令都使用 Force 参数，即使作业实例正在运行，也会删除计划作业。

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

PS C:\> Invoke-Command -ComputerName "Server01" { Unregister-ScheduledJob -Name "Test*"}

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

参数

-Confirm

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

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Force

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

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Id

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

参数属性

类型:

Int32[]

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

参数集

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

-InputObject

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

参数属性

类型:

ScheduledJobDefinition[]

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

参数集

Definition
Position:0
必需:True
来自管道的值:True
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Name

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

参数属性

类型:

String[]

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

参数集

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

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

CommonParameters

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

输入

ScheduledJobDefinition

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

输出

None

此 cmdlet 将不生成任何输出。