Receive-Job

Modul:

Microsoft.PowerShell.Core

Lekéri a PowerShell-háttérfeladatok eredményeit az aktuális munkamenetben.

Syntax

Receive-Job
       [-Job] <Job[]>
       [[-Location] <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
       [-Job] <Job[]>
       [[-ComputerName] <String[]>]
       [-Keep]
       [-NoRecurse]
       [-Force]
       [-Wait]
       [-AutoRemoveJob]
       [-WriteEvents]
       [-WriteJobInResults]
       [<CommonParameters>]

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

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

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

Description

A Receive-Job parancsmag lekéri a PowerShell-háttérfeladatok eredményeit, például azokat, amelyek a Start-Job parancsmag vagy bármely parancsmag AsJob paraméterének használatával kezdődnek. Lekérheti az összes feladat eredményét, vagy azonosíthatja a feladatokat a nevük, az azonosítójuk, a példányazonosítójuk, a számítógép neve, a hely vagy a munkamenet alapján, vagy egy feladatobjektum elküldésével.

Amikor elindít egy PowerShell-háttérfeladatot, a feladat elindul, de az eredmények nem jelennek meg azonnal. Ehelyett a parancs egy olyan objektumot ad vissza, amely a háttérfeladatot jelöli. A feladatobjektum hasznos információkat tartalmaz a feladatról, de nem tartalmazza az eredményeket. Ezzel a módszerrel folytathatja a munkát a munkamenetben a feladat futtatása közben. További információ a PowerShell háttérfeladatairól: about_Jobs.

A Receive-Job parancsmag lekéri a parancs elküldésekor Receive-Job létrehozott eredményeket. Ha az eredmények még nem fejeződnek be, további Receive-Job parancsokat futtathat a fennmaradó eredmények lekéréséhez.

Alapértelmezés szerint a rendszer törli a feladat eredményeit a rendszerből, amikor megkapja őket, de a Keep paraméter használatával mentheti az eredményeket, hogy újra megkaphassa őket. A feladat eredményeinek törléséhez futtassa újra a Receive-Job parancsot a Keep paraméter nélkül, zárja be a munkamenetet, vagy a parancsmaggal Remove-Job törölje a feladatot a munkamenetből.

A Windows PowerShell 3.0-tól Receive-Job kezdve egyéni feladattípusok, például munkafolyamat-feladatok és ütemezett feladatok példányai is lekérik az eredményeket. Az eredmények egyéni feladattípus beszerzésének engedélyezéséhez Receive-Job importálja az egyéni feladattípust támogató modult a munkamenetbe, mielőtt parancsot futtat Receive-Job , akár a Import-Module parancsmag használatával, akár a modul parancsmagjának használatával vagy lekérésével. Egy adott egyéni feladattípussal kapcsolatos információkért tekintse meg az egyéni feladattípus-funkció dokumentációját.

Példák

1. példa: Egy adott feladat eredményeinek lekérése

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

Ezek a parancsok az adott feladat eredményeinek lekéréséhez Receive-Job a Feladat paramétert használják.

Az első parancs elindít egy feladatot, Start-Job és a feladatobjektumot a $job változóban tárolja.

A második parancs a Receive-Job parancsmagot használja a feladat eredményeinek lekéréséhez. A feladat megadásához a Feladat paramétert használja.

2. példa: A Keep paraméter használata

$job = Start-Job -ScriptBlock {Get-Service dhcp, fakeservice}
$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

Ez a példa egy feladatot tárol a $job változóban, és a feladatot a Receive-Job parancsmagba csövezi. A -Keep paraméter arra is szolgál, hogy az összes összesített streamadat az első megtekintés után újra lekérhető legyen.

3. példa: Több háttérfeladat eredményeinek lekérése

Amikor a feladat indításához az AsJob paramétert Invoke-Command használja, a feladatobjektum a helyi számítógépen jön létre, annak ellenére, hogy a feladat a távoli számítógépeken fut. Ennek eredményeképpen helyi parancsokkal kezelheti a feladatot.

Az AsJob használatakor a PowerShell egy feladatobjektumot ad vissza, amely minden megkezdett feladathoz tartalmaz egy gyermekfeladatot. Ebben az esetben a feladatobjektum három gyermekfeladatot tartalmaz, egy-egy feladatot minden távoli számítógépen.

# 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

4. példa: Háttérfeladatok eredményeinek lekérése több távoli számítógépen

# 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 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.
$j = Invoke-Command -Session $s -ScriptBlock {​Start-Job -Name $('MyJob-' +$env:COMPUTERNAME) -ScriptBlock {(Get-Date).ToString()​}​}
# 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

Ez a példa bemutatja, hogyan lehet lekérni a háttérfeladatok eredményeit három távoli számítógépen. Az előző példától eltérően a Start-Job parancs futtatásával Invoke-Command valójában három független feladat indult el mindhárom számítógépen. Ennek eredményeképpen a parancs három feladatobjektumot adott vissza, amelyek három feladat helyileg, három különböző számítógépen futnak.

5. példa: Gyermekfeladatok elérése

A -Keep paraméter megőrzi egy feladat összesített streamjeinek állapotát, hogy újra megtekinthető legyen. E paraméter nélkül az összes összesített streamadat törlődik a feladat fogadásakor. További információ: about_Job_Details

Feljegyzés

Az összesített streamek tartalmazzák az összes gyermekfeladat streameit. Továbbra is elérheti az egyes adatfolyamokat a feladatobjektumon és a gyermekfeladat-objektumokon keresztül.

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éterek

-AutoRemoveJob

Azt jelzi, hogy ez a parancsmag törli a feladatot, miután visszaadta a feladat eredményeit. Ha a feladat több eredménnyel rendelkezik, a feladat továbbra is törlődik, de Receive-Job megjelenik egy üzenet.

Ez a paraméter csak egyéni feladattípusokon működik. Olyan feladattípusokhoz készült, amelyek a feladatot vagy a munkameneten kívüli típust mentik, például ütemezett feladatok példányaihoz.

Ez a paraméter nem használható a Wait paraméter nélkül.

Ezt a paramétert a Windows PowerShell 3.0-ban vezettük be.

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

-ComputerName

A számítógépek nevének tömbje.

Ez a paraméter a helyi számítógépen tárolt feladateredmények közül választ. Nem kap adatokat a távoli számítógépeken futó feladatokhoz. A távoli számítógépeken tárolt feladateredmények lekéréséhez használja a Invoke-Command parancsmagot egy Receive-Job távoli parancs futtatásához.

Type:	String[]
Aliases:	Cn
Position:	1
Default value:	All computers available
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-Force

Azt jelzi, hogy ez a parancsmag továbbra is várakozik, ha a feladatok felfüggesztett vagy leválasztott állapotban vannak. Alapértelmezés szerint a Várakozás paraméter Receive-Job visszaadja vagy leállítja a várakozást, amikor a feladatok az alábbi állapotok valamelyikében vannak:

• Befejeződött
• Sikertelen
• Leállítva
• Felfüggesztve
• Elválasztott.

A Force paraméter csak akkor érvényes, ha a Wait paramétert is használja a parancsban.

Ezt a paramétert a Windows PowerShell 3.0-ban vezettük be.

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

-Id

Azonosítók tömbjének megadása. Ez a parancsmag lekéri a megadott azonosítókkal rendelkező feladatok eredményeit.

Az azonosító egy egész szám, amely egyedileg azonosítja a feladatot az aktuális munkamenetben. Egyszerűbb megjegyezni és begépelni, mint a példányazonosítót, de csak az aktuális munkamenetben egyedi. Beírhat egy vagy több vesszővel elválasztott azonosítót. Egy feladat azonosítójának megkereséséhez használja Get-Joba következőt: .

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

-InstanceId

A példányazonosítók tömbjének megadása. Ez a parancsmag lekéri a megadott példányazonosítókkal rendelkező feladatok eredményeit.

A példányazonosító egy GUID, amely egyedileg azonosítja a feladatot a számítógépen. Egy feladat példányazonosítójának megkereséséhez használja a Get-Job parancsmagot.

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

-Job

Azt a feladatot adja meg, amelyhez az eredményeket lekéri.

Adjon meg egy változót, amely tartalmazza a feladatot vagy a feladatot lekérő parancsot. Feladatobjektumot is becsúszthat a parancsba Receive-Job.

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

-Keep

Azt jelzi, hogy ez a parancsmag menti az összesített streamadatokat a rendszerben, még azután is, hogy megkapta őket. Alapértelmezés szerint az összesített streamadatok törlődnek, miután megtekintette a következőt Receive-Job: .

A munkamenet bezárása vagy a feladat parancsmaggal való eltávolítása szintén törli az Remove-Job összesített streamadatokat.

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

-Location

Helytömböt ad meg. Ez a parancsmag csak a megadott helyeken lévő feladatok eredményeit kapja meg.

Type:	String[]
Position:	1
Default value:	All locations
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Rövid nevek tömbjének megadása. Ez a parancsmag lekéri a megadott neveket tartalmazó feladatok eredményeit. A helyettesítő karakterek támogatottak.

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

-NoRecurse

Azt jelzi, hogy ez a parancsmag csak a megadott feladatból kap eredményeket. Alapértelmezés szerint Receive-Job a megadott feladat összes gyermekfeladatának eredményét is lekéri.

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

-Session

Munkamenetek tömbjének megadása. Ez a parancsmag lekéri a megadott PowerShell-munkamenetben (PSSession) futtatott feladatok eredményeit. Adjon meg egy változót, amely tartalmazza a PSSessiont , vagy egy olyan parancsot, amely lekéri a PSSessiont, például egy parancsot Get-PSSession .

Type:	PSSession[]
Position:	1
Default value:	All sessions
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Wait

Azt jelzi, hogy ez a parancsmag az összes feladat eredményének beérkezéséig letiltja a parancssort. Alapértelmezés szerint Receive-Job azonnal visszaadja a rendelkezésre álló eredményeket.

Alapértelmezés szerint a Wait paraméter megvárja, amíg a feladat az alábbi állapotok egyikére nem kerül:

• Befejeződött
• Sikertelen
• Leállítva
• Felfüggesztve
• Elválasztott.

Ha a Várakozás paramétert a várakozás folytatására szeretné irányítani, ha a feladat állapota fel van függesztve vagy leválasztva, használja a Kényszerítés paramétert a Wait paraméterrel együtt.

Ezt a paramétert a Windows PowerShell 3.0-ban vezettük be.

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

-WriteEvents

Azt jelzi, hogy ez a parancsmag a feladat állapotának változásait jelenti, amíg a feladat befejeződik.

Ez a paraméter csak akkor érvényes, ha a Wait paramétert használja a parancs, és a Keep paraméter nincs megadva.

Ezt a paramétert a Windows PowerShell 3.0-ban vezettük be.

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

-WriteJobInResults

Azt jelzi, hogy ez a parancsmag a feladatobjektumot és az eredményeket adja vissza.

Ez a paraméter csak akkor érvényes, ha a Wait paramétert használja a parancs, és a Keep paraméter nincs megadva.

Ezt a paramétert a Windows PowerShell 3.0-ban vezettük be.

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

Bevitelek

Job

A parancsmaghoz feladatobjektumokat csövezhet.

Kimenetek

PSObject

Ez a parancsmag a feladat parancsainak eredményeit adja vissza.

Jegyzetek

A Windows PowerShell a következő aliasokat Receive-Jobtartalmazza:

• rcjb

Kapcsolódó hivatkozások

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