Stop-Job

Stop-Job
    [-Id] <Int32[]>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-Job
    [-Job] <Job[]>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-Job
    [-Name] <String[]>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-Job
    [-InstanceId] <Guid[]>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-Job
    [-State] <JobState>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-Job
    [-Filter] <Hashtable>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Командлет Stop-Job останавливает фоновые задания PowerShell, которые выполняются. Этот командлет можно использовать для остановки всех заданий или остановки выбранных заданий на основе их имени, идентификатора, идентификатора экземпляра или состояния или передачи объекта задания в Stop-Job.

Вы можете использовать Stop-Job для остановки фоновых заданий, таких как запущенные с помощью командлета Start-Job или параметра asJob asJob любого командлета. При остановке фонового задания PowerShell завершает все задачи, ожидающие в этой очереди заданий, а затем завершает задание. После отправки этой команды новые задачи не добавляются в очередь.

Этот командлет не удаляет фоновые задания. Чтобы удалить задание, используйте командлет Remove-Job.

Начиная с Windows PowerShell 3.0, Stop-Job также останавливает пользовательские типы заданий, например рабочих заданий и экземпляры ScheduledJobs. Чтобы разрешить Stop-Job остановить задание с пользовательским типом задания, импортируйте модуль, поддерживающий настраиваемый тип задания в сеанс перед выполнением команды Stop-Job, с помощью командлета Import-Module или с помощью или получения командлета в модуле. Сведения о конкретном пользовательском типе задания см. в документации по функции пользовательского типа задания.

$s = New-PSSession -ComputerName Server01 -Credential Domain01\Admin02
$j = Invoke-Command -Session $s -ScriptBlock {Start-Job -ScriptBlock {Get-EventLog -LogName System}}
Invoke-Command -Session $s -ScriptBlock { Stop-Job -Job $Using:j }

В этом примере показано, как использовать командлет Stop-Job для остановки задания, выполняемого на удаленном компьютере.

Так как задание было запущено с командлетом Invoke-Command для удаленного выполнения команды Start-Job, объект задания хранится на удаленном компьютере. Для удаленного выполнения команды Invoke-Command необходимо использовать другую команду Stop-Job. Дополнительные сведения о удаленных фоновых заданиях см. в about_Remote_Jobs.

Первая команда создает сеанс PowerShell (PSSession) на компьютере Server01, а затем сохраняет объект сеанса в переменной $s. Команда использует учетные данные администратора домена.

Вторая команда использует командлет Invoke-Command для выполнения команды Start-Job в сеансе. Команда в задании получает все события в журнале событий системы. Результирующий объект задания хранится в переменной $j.

Третья команда останавливает задание. Он использует командлет Invoke-Command для выполнения команды Stop-Job в PSSession на сервере Server01. Так как объекты заданий хранятся в $j, которая является переменной на локальном компьютере, команда использует модификатор области Using: для идентификации $j в качестве локальной переменной. Дополнительные сведения о модификаторе Using: области см. в about_Remote_Variables.

По завершении команды задание остановлено, а PSSession в $s доступно для использования.

Stop-Job -Name "Job1"

Эта команда останавливает фоновое задание Job1.

Stop-Job -Id 1, 3, 4

Эта команда останавливает три задания. Он определяет их идентификаторами .

Get-Job | Stop-Job

Эта команда останавливает все фоновые задания в текущем сеансе.

Stop-Job -State Blocked

Эта команда останавливает все заблокированные задания.

Get-Job | Format-Table ID, Name, Command, @{Label="State";Expression={$_.JobStateInfo.State}},
InstanceId -Auto

Id Name Command                 State  InstanceId
-- ---- -------                 -----  ----------
1 Job1 Start-Service schedule Running 05abb67a-2932-4bd5-b331-c0254b8d9146
3 Job3 Start-Service schedule Running c03cbd45-19f3-4558-ba94-ebe41b68ad03
5 Job5 Get-Service s*         Blocked e3bbfed1-9c53-401a-a2c3-a8db34336adf

Stop-Job -InstanceId e3bbfed1-9c53-401a-a2c3-a8db34336adf

Эти команды показывают, как остановить задание на основе InstanceId.

Первая команда использует командлет Get-Job для получения заданий в текущем сеансе. Команда использует оператор конвейера (|) для отправки заданий в команду Format-Table, которая отображает таблицу указанных свойств каждого задания. Таблица содержит InstanceId каждого задания. Он использует вычисляемое свойство для отображения состояния задания.

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

$j = Invoke-Command -ComputerName Server01 -ScriptBlock {Get-EventLog -LogName System} -AsJob
$j | Stop-Job -PassThru

Id    Name    State      HasMoreData     Location         Command
--    ----    ----       -----------     --------         -------
5     Job5    Stopped    True            user01-tablet    Get-EventLog -LogName Sy...

В этом примере показано, как использовать командлет Stop-Job для остановки задания, выполняемого на удаленном компьютере.

Так как задание было запущено с параметром AsJob командлета Invoke-Command, объект job находится на локальном компьютере, даже если задание выполняется на удаленном компьютере. Поэтому для остановки задания можно использовать локальную команду Stop-Job.

Первая команда использует командлет Invoke-Command для запуска фонового задания на компьютере Server01. Команда использует параметр AsJob для выполнения удаленной команды в качестве фонового задания.

Эта команда возвращает объект задания, который является тем же объектом задания, что возвращает командлет Start-Job. Команда сохраняет объект задания в переменной $j.

Вторая команда использует оператор конвейера для отправки задания в переменную $j в Stop-Job. Команда использует параметр PassThru для прямого Stop-Job для возврата объекта задания. Отображение объекта задания подтверждает, что состояние задания остановлено.

Дополнительные сведения о удаленных фоновых заданиях см. в about_Remote_Jobs.

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

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

По умолчанию этот командлет не возвращает выходные данные.

При использовании параметра PassThru этот командлет возвращает объект задания.

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

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