Sdílet prostřednictvím

Receive-Job

Modul:
Microsoft.PowerShell.Core Module

Získá výsledky úloh na pozadí PowerShellu v aktuální relaci.

Syntaxe

Location (Výchozí) 

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

Rutina Receive-Job získá výsledky úloh na pozadí PowerShellu, jako jsou úlohy spouštěné pomocí rutiny Start-Job nebo AsJob parametru jakékoli rutiny. Můžete získat výsledky všech úloh nebo identifikovat úlohy podle jejich názvu, ID, ID instance, názvu počítače, umístění nebo relace nebo odesláním objektu úlohy.

Když spustíte úlohu PowerShellu na pozadí, úloha se spustí, ale výsledky se nezobrazí okamžitě. Místo toho příkaz vrátí objekt, který představuje úlohu na pozadí. Objekt úlohy obsahuje užitečné informace o úloze, ale neobsahuje výsledky. Tato metoda umožňuje pokračovat v práci v relaci během spuštění úlohy. Další informace o úlohách na pozadí v PowerShellu najdete v tématu about_Jobs.

Rutina Receive-Job získá výsledky vygenerované časem odeslání příkazu Receive-Job. Pokud se výsledky ještě nedokončí, můžete spustit další příkazy Receive-Job a získat zbývající výsledky.

Ve výchozím nastavení se výsledky úloh odstraní ze systému, jakmile je obdržíte, ale k uložení výsledků můžete použít parametr Zachovat, abyste je mohli znovu přijmout. Pokud chcete odstranit výsledky úlohy, spusťte příkaz Receive-Job znovu bez parametru Keep, zavřete relaci nebo pomocí rutiny Remove-Job odstraňte úlohu z relace.

Počínaje windows PowerShellem 3.0 Receive-Job získá také výsledky vlastních typů úloh, jako jsou úlohy pracovního postupu a instance naplánovaných úloh. Pokud chcete povolit Receive-Job získat výsledky vlastního typu úlohy, naimportujte modul, který podporuje vlastní typ úlohy, před spuštěním příkazu Receive-Job buď pomocí rutiny Import-Module, nebo získáním rutiny v modulu. Informace o konkrétním vlastním typu úlohy najdete v dokumentaci funkce vlastního typu úlohy.

Příklady

Příklad 1: Získání výsledků pro konkrétní úlohu

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

Tyto příkazy používají parametr JobReceive-Job k získání výsledků konkrétní úlohy.

První příkaz spustí úlohu s Start-Job a uloží objekt úlohy do proměnné $job.

Druhý příkaz použije rutinu Receive-Job k získání výsledků úlohy. K určení úlohy používá parametr Job.

Příklad 2: Použití parametru 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

Tento příklad uloží úlohu do proměnné $job a úlohu předá rutině Receive-Job. Parametr -Keep slouží také k povolení opětovného načtení všech agregovaných dat datového proudu po prvním zobrazení.

Příklad 3: Získání výsledků několika úloh na pozadí

Pokud ke spuštění úlohy použijete parametr AsJobInvoke-Command, objekt úlohy se vytvoří v místním počítači, i když úloha běží na vzdálených počítačích. Výsledkem je, že ke správě úlohy použijete místní příkazy.

Při použití AsJobvrátí PowerShell jeden objekt úlohy, který obsahuje podřízenou úlohu pro každou spuštěnou úlohu. V tomto případě objekt úlohy obsahuje tři podřízené úlohy, jednu pro každou úlohu na každém vzdáleném počítači.

# 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

Příklad 4: Získání výsledků úloh na pozadí na více vzdálených počítačích

# 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

Tento příklad ukazuje, jak získat výsledky úloh na pozadí spuštěné na třech vzdálených počítačích. Na rozdíl od předchozího příkladu se spuštění příkazu Invoke-Command pomocí Start-Job skutečně spustily tři nezávislé úlohy na každém ze tří počítačů. Příkaz vrátil tři objekty úlohy představující tři úlohy spuštěné místně na třech různých počítačích.

Příklad 5: Přístup k podřízeným úloh

Parametr -Keep zachovává stav agregovaných datových proudů úlohy, aby bylo možné ho znovu zobrazit. Bez tohoto parametru se při přijetí úlohy vymažou všechna agregovaná data datového proudu. Další informace najdete v tématu about_Job_Details

Poznámka:

Agregované datové proudy zahrnují datové proudy všech podřízených úloh. K jednotlivým datovým proudům můžete stále přistupovat prostřednictvím objektu úlohy a podřízených objektů úlohy.

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

Parametry

-AutoRemoveJob

Označuje, že tato rutina odstraní úlohu po vrácení výsledků úlohy. Pokud má úloha více výsledků, úloha se stále odstraní, ale Receive-Job zobrazí zprávu.

Tento parametr funguje pouze u vlastních typů úloh. Je určena pro instance typů úloh, které ukládají úlohu nebo typ mimo relaci, například instance naplánovaných úloh.

Tento parametr nelze použít bez parametru Wait.

Tento parametr byl představen ve Windows PowerShellu 3.0.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-ComputerName

Určuje pole názvů počítačů.

Tento parametr se vybere z výsledků úlohy, které jsou uložené v místním počítači. Nezískáte data pro úlohy spuštěné na vzdálených počítačích. Pokud chcete získat výsledky úloh uložené ve vzdálených počítačích, použijte rutinu Invoke-Command ke vzdálenému spuštění příkazu Receive-Job.

Vlastnosti parametru

Typ:

String[]

Default value:All computers available
Podporuje zástupné znaky:True
DontShow:False
Aliasy:Kn

Sady parametrů

ComputerName
Position:1
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Force

Označuje, že tato rutina pokračuje v čekání, pokud jsou úlohy ve stavu Pozastaveno nebo Odpojeno. Ve výchozím nastavení vrátí parametr WaitReceive-Job nebo ukončí čekání, pokud jsou úlohy v jednom z následujících stavů:

  • Dokončeno
  • Neúspěšné
  • Zastavený
  • Pozastavený
  • Nesouvislý.

Parametr Force je platný pouze v případech, kdy se v příkazu používá také parametr Wait.

Tento parametr byl představen ve Windows PowerShellu 3.0.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Id

Určuje pole ID. Tato rutina získá výsledky úloh se zadanými ID.

ID je celé číslo, které jednoznačně identifikuje úlohu v aktuální relaci. Je jednodušší si zapamatovat a zadat id instance, ale je jedinečné pouze v aktuální relaci. Můžete zadat jedno nebo více ID oddělených čárkami. K vyhledání ID úlohy použijte Get-Job.

Vlastnosti parametru

Typ:

Int32[]

Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

SessionIdParameterSet
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-InstanceId

Určuje pole identifikátorů instancí. Tato rutina získá výsledky úloh se zadanými ID instancí.

ID instance je identifikátor GUID, který jednoznačně identifikuje úlohu v počítači. K vyhledání ID instance úlohy použijte rutinu Get-Job.

Vlastnosti parametru

Typ:

Guid[]

Default value:All instances
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

InstanceIdParameterSet
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Job

Určuje úlohu, pro kterou se načítají výsledky.

Zadejte proměnnou obsahující úlohu nebo příkaz, který úlohu získá. Objekt úlohy můžete také pipetovat do Receive-Job.

Vlastnosti parametru

Typ:

Job[]

Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

Location
Position:0
Povinné:True
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False
Session
Position:0
Povinné:True
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False
ComputerName
Position:0
Povinné:True
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Keep

Označuje, že tato rutina ukládá agregovaná streamová data v systému, a to i po jejich přijetí. Ve výchozím nastavení se agregovaná data datového proudu vymažou po zobrazení pomocí Receive-Job.

Ukončení relace nebo odebrání úlohy pomocí rutiny Remove-Job odstraní také agregovaná data datového proudu.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Location

Určuje pole umístění. Tato rutina získá pouze výsledky úloh v zadaných umístěních.

Vlastnosti parametru

Typ:

String[]

Default value:All locations
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

Location
Position:1
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Name

Určuje pole popisných názvů. Tato rutina získá výsledky úloh se zadanými názvy. Zástupné znaky jsou podporovány.

Vlastnosti parametru

Typ:

String[]

Default value:None
Podporuje zástupné znaky:True
DontShow:False

Sady parametrů

NameParameterSet
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-NoRecurse

Označuje, že tato rutina získá výsledky pouze ze zadané úlohy. Ve výchozím nastavení Receive-Job také získá výsledky všech podřízených úloh zadané úlohy.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Session

Určuje pole relací. Tato rutina získá výsledky úloh, které byly spuštěny v zadané relaci PowerShellu (PSSession). Zadejte proměnnou, která obsahuje PSSession, nebo příkaz, který získáPSSession , například příkaz .

Vlastnosti parametru

Typ:

PSSession[]

Default value:All sessions
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

Session
Position:1
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Wait

Označuje, že tato rutina potlačí příkazový řádek, dokud nebudou přijaty všechny výsledky úloh. Ve výchozím nastavení Receive-Job okamžitě vrátí dostupné výsledky.

Ve výchozím nastavení parametr Wait čeká, dokud úloha není v jednom z následujících stavů:

  • Dokončeno
  • Neúspěšné
  • Zastavený
  • Pozastavený
  • Nesouvislý

Pokud chcete směrovat parametr Wait, aby pokračoval v čekání, pokud je stav úlohy pozastavený nebo odpojený, použijte parametr Vynucení společně s parametrem Wait.

Tento parametr byl představen ve Windows PowerShellu 3.0.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-WriteEvents

Označuje, že tato rutina hlásí změny ve stavu úlohy, zatímco čeká na dokončení úlohy.

Tento parametr je platný pouze v případě, že se v příkazu použije parametr Wait a parametr Keep vynechá.

Tento parametr byl představen ve Windows PowerShellu 3.0.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-WriteJobInResults

Označuje, že tato rutina vrátí objekt úlohy následovaný výsledky.

Tento parametr je platný pouze v případě, že se v příkazu použije parametr Wait a parametr Keep vynechá.

Tento parametr byl představen ve Windows PowerShellu 3.0.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

Job

Objekty úloh můžete do této rutiny převést.

Výstupy

PSObject

Tato rutina vrátí výsledky příkazů v úloze.

Poznámky

PowerShell obsahuje následující aliasy pro Receive-Job:

  • Všechny platformy:
    • rcjb