Remove-Job

Remove-Job
    [-Id] <Int32[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove-Job
    [-Job] <Job[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove-Job
    [-Name] <String[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove-Job
    [-InstanceId] <Guid[]>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove-Job
    [-Filter] <Hashtable>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove-Job
    [-State] <JobState>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove-Job
    [-Command <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Командлет Remove-Job удаляет фоновые задания PowerShell, которые были запущены командлетом Start-Job или командлетами, такими как Invoke-Command, которые поддерживают параметр AsJob.

Вы можете использовать Remove-Job для удаления всех заданий или удаления выбранных заданий. Задания идентифицируются имени, идентификатором , идентификатором экземпляра, командой или состоянием. Или объект задания можно отправить по конвейеру в Remove-Job. Без параметров или значений параметров Remove-Job не действует.

С PowerShell 3.0, Remove-Job может удалять пользовательские типы заданий, такие как запланированные задания и задания рабочего процесса. Например, Remove-Job удаляет запланированное задание, все экземпляры запланированного задания на диске и результаты всех запущенных экземпляров заданий.

Если вы пытаетесь удалить выполняемое задание, в Remove-Job происходит сбой. Используйте командлет Stop-Job, чтобы остановить выполнение задания. Или используйте Remove-Job с параметром Force, чтобы удалить выполняемое задание.

Задания остаются в глобальном кэше заданий, пока не удалите фоновое задание или закройте сеанс PowerShell.

В этом примере используется переменная и конвейер для удаления задания по имени.

$batch = Get-Job -Name BatchJob
$batch | Remove-Job

Get-Job использует параметр имени для указания задания BatchJob. Объект задания хранится в переменной $batch. Объект в $batch отправляется по конвейеру в Remove-Job.

Альтернативой является использование параметра задания , например Remove-Job -Job $batch.

В этом примере удаляются все задания в текущем сеансе PowerShell.

Get-Job | Remove-Job

Get-Job получает все задания в текущем сеансе PowerShell. Объекты задания отправляются по конвейеру в Remove-Job.

В этом примере удаляются все задания из текущего сеанса PowerShell, который не запущен.

Remove-Job -State NotStarted

Remove-Job использует параметр состояния для указания состояния задания.

В этом примере удаляются все задания из текущего сеанса с дружественными именами, которые заканчиваются на пакетом, включая задания, которые выполняются.

Remove-Job -Name *batch -Force

Remove-Job использует параметр Name для указания шаблона имени задания. Шаблон включает подстановочный знак звездочки (*) для поиска всех имен заданий, заканчивающихся пакетной. Параметр Force удаляет задания, которые выполняются.

В этом примере удаляется задание, запущенное на удаленном компьютере с помощью Invoke-Command с параметром AsJob.

Так как в примере используется параметр AsJob, объект задания создается на локальном компьютере. Но задание выполняется на удаленном компьютере. В результате для управления заданием используются локальные команды.

$job = Invoke-Command -ComputerName Server01 -ScriptBlock {Get-Process} -AsJob
$job | Remove-Job

Invoke-Command выполняет задание на компьютере Server01. Параметр AsJob запускает ScriptBlock в качестве фонового задания. Объект задания хранится в переменной $job. Объект переменной $job отправляется по конвейеру в Remove-Job.

В этом примере показано, как удалить задание на удаленном компьютере, запущенном с помощью Invoke-Command для запуска Start-Job. Объект задания создается на удаленном компьютере, и используются удаленные команды для управления заданием. Постоянное подключение требуется при выполнении удаленной команды Start-Job.

$S = New-PSSession -ComputerName Server01
Invoke-Command -Session $S -ScriptBlock {Start-Job -ScriptBlock {Get-Process} -Name MyJob}
Invoke-Command -Session $S -ScriptBlock {Remove-Job -Name MyJob}

New-PSSession создает PSSession( постоянное подключение) к компьютеру Server01. Подключение сохраняется в переменной $S.

Invoke-Command подключается к сеансу, сохраненном в $S. Скриптовый блок использует Start-Job для запуска удаленной задачи. Задание выполняет команду Get-Process и использует параметр Name для указания понятного имени задания MyJob.

Invoke-Command использует сеанс $S и запускает Remove-Job. Параметр имя указывает, что задание под названием MyJob будет удалено.

В этом примере задание удаляется на основе экземпляра с идентификатором.

$job = Start-Job -ScriptBlock {Get-Process powershell}
$job | Format-List -Property *
Remove-Job -InstanceId ad02b942-8007-4407-87f3-d23e71955872

State         : Completed
HasMoreData   : True
StatusMessage :
Location      : localhost
Command       : Get-Process powershell
JobStateInfo  : Completed
Finished      : System.Threading.ManualResetEvent
InstanceId    : ad02b942-8007-4407-87f3-d23e71955872
Id            : 3
Name          : Job3
ChildJobs     : {Job4}
PSBeginTime   : 7/26/2019 11:36:56
PSEndTime     : 7/26/2019 11:36:57
PSJobTypeName : BackgroundJob
Output        : {}
Error         : {}
Progress      : {}
Verbose       : {}
Debug         : {}
Warning       : {}
Information   : {}

Start-Job запускает фоновое задание, а объект задания сохраняется в переменной $job.

Объект в $job отправляется по конвейеру в Format-List. Параметр свойства использует звездочку (*) для указания того, что все свойства объекта отображаются в списке.

Remove-Job использует параметр InstanceId из экземпляра, чтобы указать задание для удаления.

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Вы можете передать объект задания в этот командлет.

Этот командлет не возвращает выходные данные.

PowerShell включает следующие псевдонимы для Remove-Job:

• Все платформы:
  • rjb

Задание PowerShell создает новый процесс. По завершении задания процесс завершается. При запуске Remove-Job состояние задания удаляется.

Если задание останавливается до завершения и его процесс не завершается, процесс принудительно завершается.