Unregister-ScheduledJob
Удаляет запланированные задания на локальном компьютере.
Синтаксис
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 удаляет запланированные задания с локального компьютера.
При удалении или отмене регистрации запланированного задания Unregister-ScheduledJob удаляет каталог запланированного задания (в каталоге $home\AppData\Local\Microsoft\Windows\PowerShell\ScheduledJobs), содержащий XML-файл, определяющий запланированное задание, журнал выполнения заданий и все результаты задания. Это действие также удаляет задание из планировщика заданий.
Unregister-ScheduledJob удаляет только запланированные задания, созданные с помощью командлета Register-ScheduledJob. Он не удаляет запланированные задания, созданные в планировщике заданий.
Вы можете использовать параметры Unregister-ScheduledJob для удаления запланированных заданий по идентификатору или имени или передать запланированные задания из Get-ScheduledJob в Unregister-ScheduledJob.
Unregister-ScheduledJob — это один из наборов командлетов планирования заданий в модуле PSScheduledJob, включенных в Windows PowerShell.
Дополнительные сведения о запланированных заданиях см. в разделах описания в модуле PSScheduledJob.
Импортируйте модуль PSScheduledJob, а затем введите Get-Help about_Scheduled*
или просмотрите статью about_Scheduled_Jobs.
Этот командлет впервые появился в 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 для получения всех запланированных заданий на локальном компьютере. Конвейерный оператор (|) отправляет запланированные задания в командлет Unregister-ScheduleJob, который удаляет их.
Вторая команда использует параметр Name командлета Unregister-ScheduledJob со значением "все" (*) для удаления всех запланированных заданий.
Обе команды используют параметр Force, который удаляет запланированное задание, даже если выполняется его экземпляр.
Пример 3. Удаление запланированного задания на удаленном компьютере
PS C:\> Invoke-Command -ComputerName "Server01" { Unregister-ScheduledJob -Name "Test*"}
Эта команда удаляет запланированные задания с именами, начинающимися с Test на удаленном компьютере Server01. Команда использует командлет Invoke-Command для выполнения команды Unregister-ScheduledJob на компьютере Server02.
Параметры
-Confirm
Запрос подтверждения перед выполнением командлета.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Удаляет запланированное задание, даже если выполняется его экземпляр. По умолчанию Unregister-ScheduledJob не приводит к прекращению выполнения заданий.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Id
Удаляет запланированные задания с указанными идентификационными номерами (идентификаторами). Введите идентификаторы запланированных заданий на компьютере.
Type: | Int32[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Указывает запланированное задание. Введите переменную, содержащую объекты ScheduledJob , или введите команду или выражение, которое получает объекты ScheduledJob , например команду Get-ScheduledJob. Вы также можете передать объекты ScheduledJob в Unregister-JobTrigger.
Type: | ScheduledJobDefinition[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Удаляет запланированные задания с указанными именами. Введите имена одного или нескольких запланированных заданий на компьютере. Поддерживаются подстановочные знаки.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Показывает, что произойдет при запуске командлета. Командлет не выполняется.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Входные данные
Можно передать запланированные задания в Unregister-ScheduledJob.
Выходные данные
None
Этот командлет не формирует никаких выходных данных.
Связанные ссылки
- about_Scheduled_Jobs
- Add-JobTrigger
- Disable-JobTrigger
- Disable-ScheduledJob
- Enable-JobTrigger
- Enable-ScheduledJob
- Get-JobTrigger
- Get-ScheduledJob
- Get-ScheduledJobOption
- New-JobTrigger
- New-ScheduledJobOption
- Register-ScheduledJob
- Remove-JobTrigger
- Set-JobTrigger
- Set-ScheduledJob
- Set-ScheduledJobOption
- Unregister-ScheduledJob