Stop-Job

Stoppt einen PowerShell-Hintergrundauftrag.

Syntax

Stop-Job
    [-PassThru]
    [-Id] <Int32[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-Job
    [-Job] <Job[]>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-Job
    [-PassThru]
    [-Name] <String[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-Job
    [-PassThru]
    [-InstanceId] <Guid[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-Job
    [-PassThru]
    [-State] <JobState>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-Job
    [-PassThru]
    [-Filter] <Hashtable>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Beschreibung

Das Stop-Job Cmdlet beendet PowerShell-Hintergrundaufträge, die in Bearbeitung sind. Mit diesem Cmdlet können Sie alle Aufträge beenden oder ausgewählte Aufträge beenden, basierend auf ihrem Namen, der ID, der Instanz-ID oder dem Zustand oder durch Übergeben eines Auftragsobjekts an Stop-Job.

Sie können die Stop-Job Hintergrundaufträge beenden, z. B. diese, die mit dem Cmdlet oder dem Start-JobAsJob-Parameter eines beliebigen Cmdlets gestartet wurden. Wenn Sie einen Hintergrundauftrag beenden, abgeschlossen PowerShell alle Vorgänge, die in dieser Auftragswarteschlange ausstehen und dann den Auftrag beenden. Keine neuen Vorgänge werden in die Warteschlange hinzugefügt, nachdem dieser Befehl gesendet wird.

Mit diesem Cmdlet werden die Hintergrundaufträge nicht gelöscht. Um einen Auftrag zu löschen, verwenden Sie das Remove-Job Cmdlet.

Ab Windows PowerShell 3.0 Stop-Job werden auch benutzerdefinierte Auftragstypen wie WorkflowJobs und Instanzen von ScheduledJobs beendet. Stop-Job Um einen Auftrag mit benutzerdefiniertem Auftragstyp zu beenden, importieren Sie das Modul, das den benutzerdefinierten Auftragstyp unterstützt, bevor Sie einen Befehl ausführen, entweder mithilfe des Import-Module Cmdlets oder mithilfe oder Abrufen eines Stop-Job Cmdlets im Modul. Informationen zu einem bestimmten benutzerdefinierten Auftragstyp finden Sie in der Dokumentation der Funktion „Benutzerdefinierte Auftragstypen“.

Beispiele

Beispiel 1: Beenden eines Auftrags auf einem Remotecomputer mit Invoke-Command

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

In diesem Beispiel wird gezeigt, wie Sie das Cmdlet verwenden, um einen Auftrag zu beenden, der Stop-Job auf einem Remotecomputer ausgeführt wird.

Da der Auftrag mit dem Invoke-Command Cmdlet gestartet wurde, um einen Start-Job Befehl remote auszuführen, wird das Auftragsobjekt auf dem Remotecomputer gespeichert. Sie müssen einen anderen Invoke-Command Befehl verwenden, um einen Stop-Job Befehl remote auszuführen. Weitere Informationen zu Remotehintergrundaufträgen finden Sie unter „about_Remote_Jobs“.

Der erste Befehl erstellt eine PowerShell-Sitzung (PSSession) auf dem Server01-Computer und speichert dann das Sitzungsobjekt in der $s Variable. Der Befehl verwendet die Anmeldeinformationen eines Domänenadministrators.

Der zweite Befehl verwendet das Invoke-Command Cmdlet, um einen Start-Job Befehl in der Sitzung auszuführen. Der Befehl im Auftrag ruft alle Ereignisse im Systemereignisprotokoll ab. Das resultierende Auftragsobjekt wird in der $j Variablen gespeichert.

Mit dem dritten Befehl wird der Auftrag beendet. Es verwendet das Invoke-Command Cmdlet, um einen Stop-Job Befehl in der PSSession auf Server01 auszuführen. Da die Auftragsobjekte auf dem lokalen Computer gespeichert $jwerden, was eine Variable auf dem lokalen Computer ist, verwendet der Befehl den Using-Bereichsmodifizierer, um als lokale Variable zu identifizieren.$j Weitere Informationen zum Verwenden des Bereichsmodifizierers finden Sie unter about_Remote_Variables.

Wenn der Befehl abgeschlossen ist, wird der Auftrag beendet, und die PSSession$s ist für die Verwendung verfügbar.

Beispiel 2: Beenden eines Hintergrundauftrags

Stop-Job -Name "Job1"

Dieser Befehl beendet den Job1 Hintergrundauftrag.

Beispiel 3: Beenden mehrerer Hintergrundaufträge

Stop-Job -Id 1, 3, 4

Mit diesem Befehl werden drei Aufträge beendet. Sie identifiziert sie durch ihre IDs.

Beispiel 4: Beenden aller Hintergrundaufträge

Get-Job | Stop-Job

Mit diesem Befehl werden alle Hintergrundaufträge im in der aktuellen Sitzung beendet.

Beispiel 5: Beenden aller blockierten Hintergrundaufträge

Stop-Job -State Blocked

Dieser Befehl beendet alle Aufträge, die blockiert sind.

Beispiel 6: Beenden eines Auftrags nach Instanz-ID

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

Diese Befehle zeigen, wie Sie einen Auftrag basierend auf der InstanzID beenden.

Der erste Befehl verwendet das Get-Job Cmdlet, um die Aufträge in der aktuellen Sitzung abzurufen. Der Befehl verwendet einen Pipelineoperator (|) zum Senden der Aufträge an einen Format-Table Befehl, der eine Tabelle der angegebenen Eigenschaften jedes Auftrags anzeigt. Die Tabelle enthält die InstanzID jedes Auftrags. Er verwendet eine berechnete Eigenschaft, um den Auftragsstatus anzuzeigen.

Der zweite Befehl verwendet einen Stop-Job Befehl, der den InstanceID-Parameter enthält, um einen ausgewählten Auftrag zu beenden.

Beispiel 7: Beenden eines Auftrags auf einem Remotecomputer

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

Id    Name    State      HasMoreData     Location         Command
--    ----    ----       -----------     --------         -------
5     Job5    Stopped    True            user01-tablet    get-eventlog system

In diesem Beispiel wird gezeigt, wie Sie das Cmdlet verwenden, um einen Auftrag zu beenden, der Stop-Job auf einem Remotecomputer ausgeführt wird.

Da der Auftrag mit dem AsJob-Parameter des Invoke-Command Cmdlets gestartet wurde, befindet sich das Job-Objekt auf dem lokalen Computer, obwohl der Auftrag auf dem Remotecomputer ausgeführt wird. Daher können Sie einen lokalen Stop-Job Befehl verwenden, um den Auftrag zu beenden.

Der erste Befehl verwendet das Invoke-Command Cmdlet, um einen Hintergrundauftrag auf dem Server01-Computer zu starten. Der Befehl verwendet den AsJob-Parameter, um den Remotebefehl als Hintergrundauftrag auszuführen.

Dieser Befehl gibt ein Auftragsobjekt zurück, das das gleiche Auftragsobjekt ist, das das Start-Job Cmdlet zurückgibt. Der Befehl speichert das Auftragsobjekt in der $j Variablen.

Der zweite Befehl verwendet einen Pipelineoperator, um den Auftrag in der $j Variablen an Stop-Job. Der Befehl verwendet den PassThru-Parameter , um ein Auftragsobjekt zurückzugeben Stop-Job . Die Auftragsobjektanzeige bestätigt, dass der Status des Auftrags beendet wird.

Weitere Informationen zu Remotehintergrundaufträgen finden Sie unter about_Remote_Jobs.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

Gibt eine Hashtabelle der Bedingungen an. Dieses Cmdlet beendet Aufträge, die jede Bedingung erfüllen. Geben Sie eine Hashtabelle ein, in der die Schlüssel Auftragseigenschaften und die Werte Werte der Auftragseigenschaften sind.

Dieser Parameter funktioniert nur für benutzerdefinierte Auftragstypen, z. B. WorkflowJobs und ScheduledJobs. Es funktioniert nicht für Standardhintergrundaufträge, z. B. die, die mithilfe des Start-Job Cmdlets erstellt wurden. Weitere Informationen zur Unterstützung für diesen Parameter finden Sie unter dem Hilfethema für den Auftragstyp.

Dieser Parameter wurde in Windows PowerShell 3.0 eingeführt.

Type:Hashtable
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Id

Gibt die IDs von Aufträgen an, die dieses Cmdlet beendet. Der Standardwert ist alle Aufträge in der aktuellen Sitzung.

Die ID ist eine ganze Zahl, die den Auftrag in der aktuellen Sitzung eindeutig identifiziert. Es ist einfacher, sich an die Instanz-ID zu erinnern und einzugeben, aber es ist nur in der aktuellen Sitzung eindeutig. Sie können eine oder mehrere IDs eingeben, getrennt durch Kommas. Geben Sie Get-Jobdie ID eines Auftrags ein.

Type:Int32[]
Position:0
Default value:All jobs
Accept pipeline input:True
Accept wildcard characters:False

-InstanceId

Gibt die Instanz-IDs von Aufträgen an, die dieses Cmdlet beendet. Standardmäßig werden alle Aufträge fortgesetzt.

Eine Instanz-ID ist eine GUID, die den Auftrag auf dem Computer eindeutig identifiziert. Um die Instanz-ID eines Auftrags zu finden, verwenden Sie Get-Job.

Type:Guid[]
Position:0
Default value:All jobs
Accept pipeline input:True
Accept wildcard characters:False

-Job

Gibt die Aufträge an, die dieses Cmdlet beendet. Geben Sie eine Variable ein, die entweder die Aufträge oder einen Befehl enthält, durch den die Aufträge abgerufen werden. Sie können auch einen Pipelineoperator verwenden, um Aufträge an das Stop-Job Cmdlet zu übermitteln. Löscht standardmäßig Stop-Job alle Aufträge, die in der aktuellen Sitzung gestartet wurden.

Type:Job[]
Position:0
Default value:All jobs
Accept pipeline input:True
Accept wildcard characters:False

-Name

Gibt Anzeigenamen von Aufträgen an, die dieses Cmdlet beendet. Geben Sie die Auftragsnamen in einer durch Komma getrennten Liste ein, oder verwenden Sie Wildcardzeichen (*), um ein Auftragsnamenmuster einzugeben. Beenden Sie standardmäßig Stop-Job alle Aufträge, die in der aktuellen Sitzung erstellt wurden.

Da der Anzeigename nicht eindeutig sein soll, verwenden Sie die Parameter "WhatIf " und "Bestätigen " beim Beenden von Aufträgen nach Name.

Type:String[]
Position:0
Default value:All jobs
Accept pipeline input:True
Accept wildcard characters:True

-PassThru

Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-State

Gibt einen Auftragsstatus an. Dieses Cmdlet beendet nur Aufträge im angegebenen Zustand. Zulässige Werte für diesen Parameter:

  • NotStarted
  • Running
  • Completed
  • Failed
  • Stopped
  • Blocked
  • Suspended
  • Disconnected
  • Suspending
  • Stopping

Weitere Informationen zu Auftragszuständen finden Sie unter JobState Enumeration.

Type:JobState
Accepted values:NotStarted, Running, Completed, Failed, Stopped, Blocked, Suspended, Disconnected, Suspending, Stopping, AtBreakpoint
Position:0
Default value:All jobs
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

System.Management.Automation.RemotingJob

Sie können ein Auftragsobjekt an dieses Cmdlet weiterleiten.

Ausgaben

None, System.Management.Automation.PSRemotingJob

Dieses Cmdlet gibt ein Auftragsobjekt zurück, wenn Sie den PassThru-Parameter angeben. Andernfalls wird von diesem Cmdlet keine Ausgabe generiert.