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>]

Das cmdlet Remove-Job löscht PowerShell-Hintergrundaufträge, die vom Cmdlet Start-Job oder von Cmdlets wie Invoke-Command gestartet wurden, die den parameter AsJob unterstützen.

Sie können Remove-Job verwenden, um alle Aufträge zu löschen oder ausgewählte Aufträge zu löschen. Die Aufträge werden durch ihre Name, ID, InstanceId, Commandoder Stateidentifiziert. Oder ein Job-Objekt kann in der Pipeline an Remove-Job gesendet werden. Ohne Parameter oder Parameterwerte hat Remove-Job keine Auswirkung.

Seit PowerShell 3.0 können Remove-Job benutzerdefinierte Auftragstypen löschen, z. B. geplante Aufträge und Workflowaufträge. Beispielsweise löscht Remove-Job den geplanten Auftrag, alle Instanzen des geplanten Auftrags auf dem Datenträger und die Ergebnisse aller ausgelösten Auftragsinstanzen.

Wenn Sie versuchen, einen ausgeführten Auftrag zu löschen, schlägt Remove-Job fehl. Verwenden Sie das Cmdlet Stop-Job, um einen ausgeführten Auftrag zu beenden. Oder verwenden Sie Remove-Job mit dem Parameter Force, um einen ausgeführten Auftrag zu löschen.

Aufträge verbleiben im globalen Auftragscache, bis Sie den Hintergrundauftrag löschen oder die PowerShell-Sitzung schließen.

In diesem Beispiel werden eine Variable und die Pipeline verwendet, um einen Job anhand des Namens zu löschen.

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

Get-Job verwendet den Parameter Name, um den Auftrag anzugeben, BatchJob. Das Auftragsobjekt wird in der variablen $batch gespeichert. Das Objekt in $batch wird durch die Pipeline zu Remove-Jobweitergeleitet.

Eine Alternative besteht darin, den Parameter Job zu verwenden, z. B. Remove-Job -Job $batch.

In diesem Beispiel werden alle Aufträge in der aktuellen PowerShell-Sitzung gelöscht.

Get-Job | Remove-Job

Get-Job ruft alle Jobs in der aktuellen PowerShell Sitzung ab. Die Job-Objekte werden in der Pipeline an Remove-Job gesendet.

In diesem Beispiel werden alle Aufträge aus der aktuellen PowerShell-Sitzung gelöscht, die noch nicht gestartet wurden.

Remove-Job -State NotStarted

Remove-Job verwendet den Parameter State, um den Auftragsstatus anzugeben.

In diesem Beispiel werden alle Jobs der aktuellen Sitzung mit Anzeigenamen, die auf batch enden, gelöscht, einschließlich der Jobs, die gerade ausgeführt werden.

Remove-Job -Name *batch -Force

Remove-Job verwendet den Parameter Name, um ein Auftragsnamenmuster anzugeben. Das Muster enthält den Platzhalter Stern (*), um alle Job-Namen zu finden, die mit Batch enden. Der Parameter Force löscht Jobs, die ausgeführt werden.

In diesem Beispiel wird ein Job entfernt, der auf einem Remotecomputer mit Invoke-Command und dem Parameter AsJob gestartet wurde.

Da im Beispiel der parameter AsJob verwendet wird, wird das Auftragsobjekt auf dem lokalen Computer erstellt. Der Auftrag wird jedoch auf einem Remotecomputer ausgeführt. Daher verwenden Sie lokale Befehle, um den Auftrag zu verwalten.

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

Invoke-Command führt einen Job auf dem Computer Server01 aus. Der parameter AsJob führt den ScriptBlock als Hintergrundauftrag aus. Das Auftragsobjekt wird in der variablen $job gespeichert. Das Variablenobjekt $job wird an Remove-Jobweitergeleitet.

Dieses Beispiel zeigt, wie Sie einen Job auf einem Remote-Computer entfernen, der mit Invoke-Command gestartet wurde, um Start-Job auszuführen. Das Auftragsobjekt wird auf dem Remotecomputer erstellt, und Remotebefehle werden zum Verwalten des Auftrags verwendet. Beim Ausführen eines Remote-Start-Job-Befehls ist eine dauerhafte Verbindung erforderlich.

$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 erstellt eine PSSession, eine dauerhafte Verbindung, zum Computer Server01. Die Verbindung wird in der variablen $S gespeichert.

Invoke-Command stellt eine Verbindung zu der in $Sgespeicherten Sitzung her. Der ScriptBlock verwendet Start-Job, um einen remoten Job zu starten. Der Auftrag führt einen Get-Process Befehl aus und verwendet den Parameter Name, um einen freundlichen Auftragsnamen anzugeben: MyJob.

Invoke-Command verwendet die Sitzung $S und führt Remove-Job aus. Der Parameter Name gibt an, dass der Job mit dem Namen MeinJob gelöscht wird.

In diesem Beispiel wird ein Job auf der Grundlage seiner InstanceId entfernt.

$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 startet einen Hintergrundauftrag, und das Auftragsobjekt wird in der variablen $job gespeichert.

Das Objekt in $job wird durch die Pipeline zu Format-Listweitergeleitet. Der parameter Property verwendet ein Sternchen (*), um anzugeben, dass alle Eigenschaften des Objekts in einer Liste angezeigt werden.

Remove-Job verwendet den parameter InstanceId, um den zu löschenden Auftrag anzugeben.

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Sie können diesem Cmdlet ein -Objekt über die Pipeline übergeben.

Dieses Cmdlet gibt keine Ausgabe zurück.

PowerShell enthält die folgenden Aliase für Remove-Job:

• Alle Plattformen:
  • rjb

Ein PowerShell-Auftrag erstellt einen neuen Prozess. Wenn der Job abgeschlossen ist, wird der Prozess beendet. Wenn Remove-Job ausgeführt wird, wird der Status des Jobs entfernt.

Wenn ein Job vor der Vervollständigung anhält und sein Prozess noch nicht beendet wurde, wird der Prozess zwangsweise beendet.