Receive-Job

Receive-Job
    [-Job] <Job[]>
    [[-Location] <string[]>]
    [-Keep]
    [-NoRecurse]
    [-Force]
    [-Wait]
    [-AutoRemoveJob]
    [-WriteEvents]
    [-WriteJobInResults]
    [<CommonParameters>]

Receive-Job
    [-Job] <Job[]>
    [[-ComputerName] <string[]>]
    [-Keep]
    [-NoRecurse]
    [-Force]
    [-Wait]
    [-AutoRemoveJob]
    [-WriteEvents]
    [-WriteJobInResults]
    [<CommonParameters>]

Receive-Job
    [-Job] <Job[]>
    [[-Session] <PSSession[]>]
    [-Keep]
    [-NoRecurse]
    [-Force]
    [-Wait]
    [-AutoRemoveJob]
    [-WriteEvents]
    [-WriteJobInResults]
    [<CommonParameters>]

Receive-Job
    [-Name] <string[]>
    [-Keep]
    [-NoRecurse]
    [-Force]
    [-Wait]
    [-AutoRemoveJob]
    [-WriteEvents]
    [-WriteJobInResults]
    [<CommonParameters>]

Receive-Job
    [-InstanceId] <guid[]>
    [-Keep]
    [-NoRecurse]
    [-Force]
    [-Wait]
    [-AutoRemoveJob]
    [-WriteEvents]
    [-WriteJobInResults]
    [<CommonParameters>]

Receive-Job
    [-Id] <int[]>
    [-Keep]
    [-NoRecurse]
    [-Force]
    [-Wait]
    [-AutoRemoveJob]
    [-WriteEvents]
    [-WriteJobInResults]
    [<CommonParameters>]

Das Receive-Job Cmdlet ruft die Ergebnisse von PowerShell-Hintergrundaufträgen ab, z. B. solche, die mit dem Start-Job Cmdlet oder dem AsJob-Parameter eines beliebigen Cmdlets gestartet wurden. Sie können die Ergebnisse aller Aufträge abrufen oder Aufträge anhand des Namens, der ID, der Instanz-ID, des Computernamens, des Speicherorts oder der Sitzung oder durch Übermitteln eines Auftragsobjekts identifizieren.

Wenn Sie einen PowerShell-Hintergrundauftrag starten, wird der Auftrag gestartet, aber die Ergebnisse werden nicht sofort angezeigt. Stattdessen gibt der Befehl ein Objekt zurück, das den Hintergrundauftrag darstellt. Das Auftragsobjekt enthält nützliche Informationen zum Auftrag, enthält aber nicht die Ergebnisse. Mit dieser Methode können Sie die Arbeit in der Sitzung fortsetzen, während der Auftrag ausgeführt wird. Weitere Informationen zu Hintergrundaufträgen in PowerShell finden Sie unter about_Jobs.

Das Receive-Job Cmdlet ruft die Ergebnisse ab, die zum Zeitpunkt der Übermittlung des Receive-Job Befehls generiert wurden. Wenn die Ergebnisse noch nicht abgeschlossen sind, können Sie zusätzliche Receive-Job Befehle ausführen, um die verbleibenden Ergebnisse zu erhalten.

Standardmäßig werden Auftragsergebnisse aus dem System gelöscht, wenn Sie sie erhalten, aber Sie können den Parameter Behalten verwenden, um die Ergebnisse zu speichern, damit Sie sie erneut erhalten können. Um die Auftragsergebnisse zu löschen, führen Sie den Receive-Job Befehl erneut ohne den Parameter Keep aus, schließen Sie die Sitzung, oder verwenden Sie das Cmdlet, Remove-Job um den Auftrag aus der Sitzung zu löschen.

Ab Windows PowerShell 3.0 werden Receive-Job auch die Ergebnisse von benutzerdefinierten Auftragstypen abgerufen, z. B. Workflowaufträge und Instanzen geplanter Aufträge. Um die Ergebnisse einem benutzerdefinierten Auftragstyp zu ermöglichen Receive-Job , importieren Sie das Modul, das den benutzerdefinierten Auftragstyp unterstützt, in die Sitzung, bevor ein Receive-Job Befehl ausgeführt wird, entweder mithilfe des Import-Module Cmdlets oder durch Abrufen eines Cmdlets im Modul. Informationen zu einem bestimmten benutzerdefinierten Auftragstyp finden Sie in der Dokumentation des Features für den benutzerdefinierten Auftragstyp.

$job = Start-Job -ScriptBlock {Get-Process}
Start-Sleep -Seconds 1
Receive-Job -Job $job

Diese Befehle verwenden den Job-Parameter von Receive-Job , um die Ergebnisse eines bestimmten Jobs abzurufen.

Der erste Befehl startet einen Job mit Start-Job und speichert das Job-Objekt in der $job Variablen.

Der zweite Befehl verwendet das Receive-Job Cmdlet, um die Ergebnisse des Auftrags abzurufen. Er verwendet den Job-Parameter, um den Job anzugeben.

$job = Start-Job -ScriptBlock {Get-Service dhcp, fakeservice}
Start-Sleep -Seconds 1
$job | Receive-Job -Keep

Cannot find any service with service name 'fakeservice'.
    + CategoryInfo          : ObjectNotFound: (fakeservice:String) [Get-Service], ServiceCommandException
    + FullyQualifiedErrorId : NoServiceFoundForGivenName,Microsoft.PowerShell.Commands.GetServiceCommand
    + PSComputerName        : localhost

Status   Name               DisplayName
------   ----               -----------
Running  dhcp               DHCP Client

$job | Receive-Job -Keep

Cannot find any service with service name 'fakeservice'.
    + CategoryInfo          : ObjectNotFound: (fakeservice:String) [Get-Service], ServiceCommandException
    + FullyQualifiedErrorId : NoServiceFoundForGivenName,Microsoft.PowerShell.Commands.GetServiceCommand
    + PSComputerName        : localhost

Status   Name               DisplayName
------   ----               -----------
Running  dhcp               DHCP Client

In diesem Beispiel wird ein Auftrag in der $job Variablen gespeichert und über die Pipeline an das Receive-Job Cmdlet übergeben. Der -Keep Parameter wird auch verwendet, um zu ermöglichen, dass alle aggregierten Stream-Daten nach der ersten Ansicht wieder abgerufen werden können.

Wenn Sie den AsJob-Parameter von Invoke-Command verwenden, um einen Auftrag zu starten, wird das Auftragsobjekt auf dem lokalen Computer erstellt, auch wenn der Auftrag auf den Remotecomputern ausgeführt wird. Daher verwenden Sie lokale Befehle, um den Auftrag zu verwalten.

Wenn Sie AsJob verwenden, gibt PowerShell außerdem ein Auftragsobjekt zurück, das für jeden gestarteten Auftrag einen untergeordneten Auftrag enthält. In diesem Fall enthält das Auftragsobjekt drei untergeordnete Aufträge, einen für jeden Auftrag auf jedem Remotecomputer.

# Use the Invoke-Command cmdlet with the -AsJob parameter to start a background job that
# runs a Get-Service command on three remote computers. Store the resulting job object in
# the $j variable
$j = Invoke-Command -ComputerName Server01, Server02, Server03 -ScriptBlock {Get-Service} -AsJob
# Display the value of the **ChildJobs** property of the job object in $j. The display
# shows that the command created three child jobs, one for the job on each remote
# computer. You could also use the -IncludeChildJobs parameter of the Get-Job cmdlet.
$j.ChildJobs

Id   Name     State      HasMoreData   Location       Command
--   ----     -----      -----------   --------       -------
2    Job2     Completed  True          Server01       Get-Service
3    Job3     Completed  True          Server02       Get-Service
4    Job4     Completed  True          Server03       Get-Service

# Use the Receive-Job cmdlet to get the results of just the Job3 child job that ran on the
# Server02 computer. Use the *Keep* parameter to allow you to view the aggregated stream
# data more than once.
Receive-Job -Name Job3 -Keep

Status  Name        DisplayName                        PSComputerName
------  ----------- -----------                        --------------
Running AeLookupSvc Application Experience             Server02
Stopped ALG         Application Layer Gateway Service  Server02
Running Appinfo     Application Information            Server02
Running AppMgmt     Application Management             Server02

# Use the New-PSSession cmdlet to create three user-managed PSSessions on three servers,
# and save the sessions in the $s variable.
$s = New-PSSession -ComputerName Server01, Server02, Server03
# Use Invoke-Command run a Start-Job command in each of the PSSessions in the $s variable.
# The code creates a new job with a custom name to each server. The job outputs the
# datetime from each server. Save the job objects in the $j variable.
$invokeCommandSplat = @{
    Session = $s
    ScriptBlock = {
        Start-Job -Name $('MyJob-' +$Env:COMPUTERNAME) -ScriptBlock {
            (Get-Date).ToString()
        }
    }
}
$j = Invoke-Command @invokeCommandSplat
# To confirm that these job objects are from the remote machines, run Get-Job to show no
# local jobs running.
Get-Job`
# Display the three job objects in $j. Note that the Localhost ___location is not the local
# computer, but instead localhost as it relates to the job on each Server.
$j

Id   Name               State      HasMoreData   Location   Command
--   ----               -----      -----------   --------   -------
1    MyJob-Server01     Completed  True          Localhost  (Get-Date).ToString()
2    MyJob-Server02     Completed  True          Localhost  (Get-Date).ToString()
3    MyJob-Server03     Completed  True          Localhost  (Get-Date).ToString()

# Use Invoke-Command to run a Receive-Job command in each of the sessions in the $s
# variable and save the results in the $results variable. The Receive-Job command must be
# run in each session because the jobs were run locally on each server.
$results = Invoke-Command -Session $s -ScriptBlock {
    Receive-Job -Name $('MyJob-' +$Env:COMPUTERNAME)
}

3/22/2021 7:41:47 PM
3/22/2021 7:41:47 PM
3/22/2021 9:41:47 PM

In diesem Beispiel wird gezeigt, wie die Ergebnisse von Hintergrundaufträgen abgerufen werden, die auf drei Remotecomputern ausgeführt werden. Im Gegensatz zum vorherigen Beispiel wurden beim Ausführen des Invoke-Command Befehls mit Start-Job drei unabhängige Aufträge auf jedem der drei Computer gestartet. Als Ergebnis gab der Befehl drei Auftragsobjekte zurück, die drei Aufträge darstellen, die lokal auf drei verschiedenen Computern ausgeführt werden.

Der -Keep Parameter behält den Zustand der aggregierten Datenströme eines Auftrags bei, sodass er erneut angezeigt werden kann. Ohne diesen Parameter werden alle aggregierten Stream-Daten gelöscht, wenn der Auftrag empfangen wird. Weitere Informationen finden Sie unter about_Job_Details

Start-Job -Name TestJob -ScriptBlock {dir C:\, Z:\}
# Without the Keep parameter, aggregated child job data is displayed once.
# Then destroyed.
Receive-Job -Name TestJob

    Directory: C:\

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-r---        1/24/2019   7:11 AM                Program Files
d-r---        2/13/2019   8:32 AM                Program Files (x86)
d-r---        10/3/2018  11:47 AM                Users
d-----         2/7/2019   1:52 AM                Windows
Cannot find drive. A drive with the name 'Z' does not exist.
    + CategoryInfo          : ObjectNotFound: (Z:String) [Get-ChildItem], DriveNotFoundException
    + FullyQualifiedErrorId : DriveNotFound,Microsoft.PowerShell.Commands.GetChildItemCommand
    + PSComputerName        : localhost

# It would seem that the child job data is gone.
Receive-Job -Name TestJob

# Using the object model, you can still retrieve child job data and streams.
$job = Get-Job -Name TestJob
$job.ChildJobs[0].Error

Cannot find drive. A drive with the name 'Z' does not exist.
    + CategoryInfo          : ObjectNotFound: (Z:String) [Get-ChildItem], DriveNotFoundException
    + FullyQualifiedErrorId : DriveNotFound,Microsoft.PowerShell.Commands.GetChildItemCommand
    + PSComputerName        : localhost

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 Auftragsobjekte über die Pipeline an dieses Cmdlet übergeben.

Dieses Cmdlet gibt die Ergebnisse der Befehle im Auftrag zurück.

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

• Alle Plattformen:
  • rcjb