Receive-Job
Lekéri a PowerShell-háttérfeladatok eredményeit az aktuális munkamenetben.
Syntax
Location (Alapértelmezett)
Receive-Job
[-Job] <Job[]>
[[-Location] <string[]>]
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[<CommonParameters>]
ComputerName
Receive-Job
[-Job] <Job[]>
[[-ComputerName] <string[]>]
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[<CommonParameters>]
Session
Receive-Job
[-Job] <Job[]>
[[-Session] <PSSession[]>]
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[<CommonParameters>]
NameParameterSet
Receive-Job
[-Name] <string[]>
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[<CommonParameters>]
InstanceIdParameterSet
Receive-Job
[-InstanceId] <guid[]>
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[<CommonParameters>]
SessionIdParameterSet
Receive-Job
[-Id] <int[]>
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[<CommonParameters>]
Description
A Receive-Job parancsmag lekéri a PowerShell háttérfeladatainak eredményeit, például azokat, amelyek a Start-Job parancsmag vagy az AsJob paraméter 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 Receive-Job parancs elküldésekor létrehozott eredményeket. Ha az eredmények még nem fejeződnek be, további Receive-Job parancsokat is futtathat a fennmaradó eredmények lekéréséhez.
Alapértelmezés szerint a rendszer törli a feladateredményeket 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 megtartása paraméter nélkül, zárja be a munkamenetet, vagy a Remove-Job parancsmaggal törölje a feladatot a munkamenetből.
A Windows PowerShell 3.0-tól kezdve a Receive-Job egyéni feladattípusok, például munkafolyamat-feladatok és ütemezett feladatok példányainak eredményeit is lekéri. Ha engedélyezni szeretné, hogy Receive-Job egyéni feladattípust kapjon az eredményekhez, importálja az egyéni feladattípust támogató modult a munkamenetbe, mielőtt egy Receive-Job parancsot futtat, akár a Import-Module parancsmag használatával, akár a modul parancsmagjának beolvasásával. 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}
Start-Sleep -Seconds 1
Receive-Job -Job $job
Ezek a parancsok a Receive-Job paraméterét használják egy adott feladat eredményeinek lekéréséhez.
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}
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
Ez a példa egy feladatot a $job változóban tárol, és a feladatot a Receive-Job parancsmagba csövezi. A -Keep paraméter használatával az összes összesített streamadat újra lekérhető az első megtekintés után.
3. példa: Több háttérfeladat eredményeinek lekérése
Amikor a AsJob paraméter Invoke-Command rel indít el egy feladatot, 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.
Ha AsJobhasznál, 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 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
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 Invoke-Command parancs futtatásához használt Start-Job valójában három független feladatot indított 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
Megjegyzé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 mentik a feladatot vagy a munkameneten kívüli típust, például ütemezett feladatok példányaihoz.
Ez a paraméter nem használható a Várakozás paraméter nélkül.
Ezt a paramétert a Windows PowerShell 3.0-ban vezettük be.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | False |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ComputerName
Megadja a számítógépek neveit tartalmazó tömböt.
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 feladatok eredményeinek lekéréséhez használja a Invoke-Command parancsmagot egy Receive-Job parancs távoli futtatásához.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | All computers available |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
| Aliasok: | Cn |
Paraméterkészletek
ComputerName
| Position: | 1 |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | True |
| Fennmaradó argumentumokból származó érték: | False |
-Force
Azt jelzi, hogy ez a parancsmag továbbra is várakozik, ha a feladatok Felfüggesztett vagy Kapcsolat nélküli állapotban vannak. Alapértelmezés szerint a Receive-Job paramétere visszaadja vagy leállítja a várakozást, amikor a feladatok az alábbi állapotok valamelyikében vannak:
- Befejeződött
- Sikertelen
- Megállt
- Felfüggesztett
- Elválasztott.
A Force paraméter csak akkor érvényes, ha a Wait paramétert is használja a parancs.
Ezt a paramétert a Windows PowerShell 3.0-ban vezettük be.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | False |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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 ez 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 a Get-Job.
Paramétertulajdonságok
| Típus: | Int32[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
SessionIdParameterSet
| Position: | 0 |
| Kötelező: | True |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | True |
| Fennmaradó argumentumokból származó érték: | 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.
Paramétertulajdonságok
| Típus: | Guid[] |
| Alapértelmezett érték: | All instances |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
InstanceIdParameterSet
| Position: | 0 |
| Kötelező: | True |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | True |
| Fennmaradó argumentumokból származó érték: | 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 Receive-Job.
Paramétertulajdonságok
| Típus: | Job[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
Location
| Position: | 0 |
| Kötelező: | True |
| Folyamatból származó érték: | True |
| Folyamatból származó érték tulajdonságnév alapján: | True |
| Fennmaradó argumentumokból származó érték: | False |
Session
| Position: | 0 |
| Kötelező: | True |
| Folyamatból származó érték: | True |
| Folyamatból származó érték tulajdonságnév alapján: | True |
| Fennmaradó argumentumokból származó érték: | False |
ComputerName
| Position: | 0 |
| Kötelező: | True |
| Folyamatból származó érték: | True |
| Folyamatból származó érték tulajdonságnév alapján: | True |
| Fennmaradó argumentumokból származó érték: | 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 a Receive-Jobmegtekintése után.
A munkamenet bezárása vagy a feladat Remove-Job parancsmaggal való eltávolítása szintén törli az összesített streamadatokat.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | False |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Location
Helytömböt ad meg. Ez a parancsmag csak a megadott helyeken lévő feladatok eredményeit kapja meg.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | All locations |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
Location
| Position: | 1 |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
NameParameterSet
| Position: | 0 |
| Kötelező: | True |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | True |
| Fennmaradó argumentumokból származó érték: | False |
-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.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | False |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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 PSSession vagy egy olyan parancsot, amely lekéri a PSSession, például egy Get-PSSession parancsot.
Paramétertulajdonságok
| Típus: | |
| Alapértelmezett érték: | All sessions |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
Session
| Position: | 1 |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | True |
| Fennmaradó argumentumokból származó érték: | 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 a Receive-Job azonnal visszaadja a rendelkezésre álló eredményeket.
Alapértelmezés szerint a Várakozás paraméter megvárja, amíg a feladat az alábbi állapotok egyikére nem kerül:
- Befejeződött
- Sikertelen
- Megállt
- Felfüggesztett
- Szétkapcsolva
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ítse paramétert a Várakozás paraméterrel együtt.
Ezt a paramétert a Windows PowerShell 3.0-ban vezettük be.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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 ki van hagyva.
Ezt a paramétert a Windows PowerShell 3.0-ban vezettük be.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | False |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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 ki van hagyva.
Ezt a paramétert a Windows PowerShell 3.0-ban vezettük be.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | False |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
CommonParameters
Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.
Bevitelek
Job
A parancsmaghoz feladatobjektumokat csövezhet.
Kimenetek
PSObject
Ez a parancsmag a feladat parancsainak eredményeit adja vissza.
Jegyzetek
A PowerShell a következő aliasokat tartalmazza Receive-Job:
- Minden platform:
rcjb
