Receive-Job

Syntaxe

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

Description

L’applet Receive-Job de commande obtient les résultats des travaux en arrière-plan PowerShell, tels que ceux démarrés à l’aide de l’applet Start-Job de commande ou du paramètre AsJob de n’importe quelle applet de commande. Vous pouvez obtenir les résultats de toutes les tâches ou identifier les tâches par leur nom, ID, ID d'instance, nom d'ordinateur, emplacement ou session, ou en envoyant un objet de traitement.

Lorsque vous démarrez un travail en arrière-plan PowerShell, le travail démarre, mais les résultats ne s’affichent pas immédiatement. À la place, la commande retourne un objet qui représente la tâche en arrière-plan. L’objet de travail contient des informations utiles sur le travail, mais il ne contient pas les résultats. Cette méthode vous permet de continuer à travailler dans la session pendant l’exécution du travail. Pour plus d’informations sur les travaux en arrière-plan dans PowerShell, consultez about_Jobs.

L’applet Receive-Job de commande obtient les résultats qui ont été générés au moment où la Receive-Job commande est envoyée. Si les résultats ne sont pas encore terminés, vous pouvez exécuter des commandes supplémentaires Receive-Job pour obtenir les résultats restants.

Par défaut, les résultats du travail sont supprimés du système lorsque vous les recevez, mais vous pouvez utiliser le paramètre Keep pour enregistrer les résultats afin de pouvoir les recevoir à nouveau. Pour supprimer les résultats du travail, réexécutez la Receive-Job commande sans le paramètre Keep , fermez la session ou utilisez l’applet Remove-Job de commande pour supprimer le travail de la session.

À compter de Windows PowerShell 3.0, Receive-Job obtient également les résultats des types de travaux personnalisés, tels que les travaux de flux de travail et les instances de travaux planifiés. Pour permettre Receive-Job d’obtenir les résultats d’un type de travail personnalisé, importez le module qui prend en charge le type de travail personnalisé dans la session avant d’exécuter une Receive-Job commande, soit à l’aide de l’applet Import-Module de commande, soit en obtenant une applet de commande dans le module. Pour plus d'informations sur un type de tâche personnalisé particulier, consultez la documentation sur la fonctionnalité de type de tâche personnalisé.

Exemples

Exemple 1 : Obtenir les résultats d’un travail particulier

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

Ces commandes utilisent le paramètre Job pour Receive-Job obtenir les résultats d’un travail particulier.

La première commande démarre un travail avec Start-Job et stocke l’objet de travail dans la $job variable.

La deuxième commande utilise l’applet Receive-Job de commande pour obtenir les résultats du travail. Il utilise le paramètre Job pour spécifier le travail.

Exemple 2 : Utiliser le paramètre Keep

$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

Cet exemple stocke un travail dans la $job variable et canalise le travail vers l’applet Receive-Job de commande. Le -Keep paramètre est également utilisé pour autoriser la récupération de toutes les données de flux agrégés après la première vue.

Exemple 3 : Obtenir les résultats de plusieurs travaux en arrière-plan

Lorsque vous utilisez le paramètre AsJob pour Invoke-Command démarrer un travail, l’objet de travail est créé sur l’ordinateur local, même si le travail s’exécute sur les ordinateurs distants. Par conséquent, vous utilisez des commandes locales pour gérer la tâche.

En outre, lorsque vous utilisez AsJob, PowerShell retourne un objet de travail qui contient un travail enfant pour chaque travail démarré. Dans ce cas, l’objet de travail contient trois travaux enfants, un pour chaque travail sur chaque ordinateur distant.

# 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

Exemple 4 : Obtenir les résultats des travaux en arrière-plan sur plusieurs ordinateurs distants

# 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

Cet exemple montre comment obtenir les résultats des tâches en arrière-plan exécutées sur trois ordinateurs distants. Contrairement à l’exemple précédent, l’utilisation Invoke-Command de la Start-Job commande a réellement démarré trois travaux indépendants sur chacun des trois ordinateurs. Par conséquent, la commande a retourné trois objets de travail représentant trois travaux exécutés localement sur trois ordinateurs différents.

Exemple 5 : Accéder aux travaux enfants

Le -Keep paramètre conserve l’état des flux agrégés d’un travail afin qu’il puisse être consulté à nouveau. Sans ce paramètre, toutes les données de flux agrégés sont effacées lorsque le travail est reçu. Pour plus d’informations, consultez 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

Paramètres

-AutoRemoveJob

-ComputerName

-Force

-Id

-InstanceId

-Job

-Keep

-Location

-Name

-NoRecurse

-Session

-Wait

-WriteEvents

-WriteJobInResults

Entrées

Job

Vous pouvez diriger les objets de travail vers cette applet de commande.

Sorties

PSObject

Cette applet de commande retourne les résultats des commandes dans le travail.

Notes

PowerShell inclut les alias suivants pour Receive-Job:

• Toutes les plateformes :
  • rcjb

Liens associés

• Get-Job
• Invoke-Command
• Remove-Job
• Start-Job
• Stop-Job
• Wait-Job