Stop-Job
Use Stop-Job to stop a running job, leaving it in the session so partial output can still be collected.
Documentation: Microsoft Learn — PowerShell module reference
Syntax
See the command anatomy
Read the command and its supplied arguments. This example requires real PowerShell or its module; this diagram does not execute it.
Stop-Job [-Job] <Job[]> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]- Stage 1Stop-Job
-Job -PassThru -WhatIf -Confirm
Try it
PowerShell example · browser support is limited.
Execution scope: The full example below requires PowerShell outside this browser. You can edit this runner to use the supported practice commands; unsupported syntax returns an explanation.
Follow the objects
Run the command to inspect each stage.
Examples
Get-Job -State Running
Show reference output
Sample output · fictional data, shaped like the real thing
Id Name PSJobTypeName State HasMoreData Location Command -- ---- ------------- ----- ----------- -------- ------- 3 Backup BackgroundJob Stopped True localhost Start-Job -ScriptBlock...
Stop-Job -State Running
Show reference output
Sample output · fictional data, shaped like the real thing
Id Name State HasMoreData Location -- ---- --------- ----------- --------- 1 Job1 Completed True localhost
Parameters
Parameter definitions:
-Job-PassThru-WhatIf-Confirm
Practical use and troubleshooting
Practical scenario: Use Stop-Job when you need to stop a running job, leaving it in the session so partial output can still be collected. Start with one identified target and inspect the returned values before extending the operation to a list. Keep the identity in your report so you can trace each result back to the object or path that produced it.
Common error and fix: A job may already have completed before Stop-Job runs. Inspect State and receive any required output instead of treating every non-running state as an operational failure. In an unattended script, capture this failure with its original error record and record which target failed. An empty result and an unsuccessful query must remain distinguishable in the final report.
See also: Remove-Job. Stop-Job requests that a job stop; Remove-Job removes its job object from the session. Removing metadata is not a substitute for deciding how to handle running work. Read the linked command before substituting it; similar names do not imply identical inputs or output.
Recap
Stop-Job Use Stop-Job to stop a running job, leaving it in the session so partial output can still be collected.
Next: Remove-Job