Start-Job

Start-Job
    [-ScriptBlock] <ScriptBlock>
    [[-InitializationScript] <ScriptBlock>]
    [-Name <String>]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-WorkingDirectory <String>]
    [-RunAs32]
    [-PSVersion <Version>]
    [-InputObject <PSObject>]
    [-ArgumentList <Object[]>]
    [<CommonParameters>]

Start-Job
    [-DefinitionName] <String>
    [[-DefinitionPath] <String>]
    [[-Type] <String>]
    [-WorkingDirectory <String>]
    [<CommonParameters>]

Start-Job
    [-FilePath] <String>
    [[-InitializationScript] <ScriptBlock>]
    [-Name <String>]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-WorkingDirectory <String>]
    [-RunAs32]
    [-PSVersion <Version>]
    [-InputObject <PSObject>]
    [-ArgumentList <Object[]>]
    [<CommonParameters>]

Start-Job
    [[-InitializationScript] <ScriptBlock>]
    -LiteralPath <String>
    [-Name <String>]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-WorkingDirectory <String>]
    [-RunAs32]
    [-PSVersion <Version>]
    [-InputObject <PSObject>]
    [-ArgumentList <Object[]>]
    [<CommonParameters>]

De Start-Job cmdlet start een PowerShell-achtergrondtaak op de lokale computer.

Een PowerShell-achtergrondtaak voert een opdracht uit zonder interactie met de huidige sessie. Wanneer u een achtergrondtaak start, wordt een taakobject onmiddellijk geretourneerd, zelfs als het langer duurt voordat de taak is voltooid. U kunt zonder onderbreking in de sessie blijven werken terwijl de taak wordt uitgevoerd.

Het taakobject bevat nuttige informatie over de taak, maar bevat geen taakresultaten. Wanneer de taak is voltooid, gebruikt u de cmdlet Receive-Job om de resultaten van de taak op te halen. Zie about_Jobsvoor meer informatie over achtergrondtaken.

Als u een achtergrondtaak wilt uitvoeren op een externe computer, gebruikt u de parameter AsJob die beschikbaar is op veel cmdlets of gebruikt u de Invoke-Command-cmdlet om een Start-Job opdracht uit te voeren op de externe computer. Zie about_Remote_Jobsvoor meer informatie.

Vanaf PowerShell 3.0 kunnen Start-Job exemplaren van aangepaste taaktypen starten, zoals geplande taken. Zie de Help-documenten voor de functie jobtype voor informatie over het gebruik van Start-Job om taken te starten met aangepaste typen.

Vanaf PowerShell 6.0 kunt u taken starten met behulp van de achtergrondoperator ampersand (&). De functionaliteit van de achtergrondoperator is vergelijkbaar met Start-Job. Beide methoden om een taak te starten, maken een PSRemotingJob taakobject. Voor meer informatie over het gebruik van het en-teken (&), zie about_Operators.

PowerShell 7 heeft de parameter WorkingDirectory geïntroduceerd waarmee de oorspronkelijke werkmap van een achtergrondtaak wordt opgegeven. Als de parameter niet is opgegeven, wordt Start-Job standaard ingesteld op de huidige werkmap van de aanroeper die de taak heeft gestart.

In dit voorbeeld wordt een achtergrondtaak gestart die wordt uitgevoerd op de lokale computer.

Start-Job -ScriptBlock { Get-Process -Name pwsh }

Id  Name   PSJobTypeName   State     HasMoreData   Location    Command
--  ----   -------------   -----     -----------   --------    -------
1   Job1   BackgroundJob   Running   True          localhost   Get-Process -Name pwsh

Start-Job gebruikt de parameter ScriptBlock om Get-Process uit te voeren als achtergrondtaak. De parameter Name geeft aan om PowerShell-processen pwshte vinden. De taakgegevens worden weergegeven en PowerShell keert terug naar een prompt terwijl de taak op de achtergrond wordt uitgevoerd.

Gebruik de cmdlet Receive-Job om de uitvoer van de taak weer te geven. Bijvoorbeeld: Receive-Job -Id 1.

In dit voorbeeld wordt de ampersand -operator (&) gebruikt om een achtergrondtaak op de lokale computer te starten. De taak krijgt hetzelfde resultaat als Start-Job in voorbeeld 1.

Get-Process -Name pwsh &

Id    Name   PSJobTypeName   State       HasMoreData     Location      Command
--    ----   -------------   -----       -----------     --------      -------
5     Job5   BackgroundJob   Running     True            localhost     Microsoft.PowerShell.Man...

Get-Process gebruikt de parameter Name om PowerShell-processen op te geven, pwsh. De ampersand (&) voert de opdracht uit als achtergrondtaak. De taakgegevens worden weergegeven en PowerShell keert terug naar een prompt terwijl de taak op de achtergrond wordt uitgevoerd.

Gebruik de cmdlet Receive-Job om de uitvoer van de taak weer te geven. Bijvoorbeeld: Receive-Job -Id 5.

In dit voorbeeld wordt een taak uitgevoerd op meerdere computers. De taak wordt opgeslagen in een variabele en wordt uitgevoerd met behulp van de naam van de variabele op de PowerShell-opdrachtregel.

$jobWRM = Invoke-Command -ComputerName (Get-Content -Path C:\Servers.txt) -ScriptBlock {
   Get-Service -Name WinRM } -JobName WinRM -ThrottleLimit 16 -AsJob

Een taak die gebruikmaakt van Invoke-Command wordt gemaakt en opgeslagen in de $jobWRM variabele. Invoke-Command gebruikt de parameter ComputerName om de computers op te geven waarop de taak wordt uitgevoerd. Get-Content haalt de servernamen op uit het C:\Servers.txt-bestand.

De parameter ScriptBlock geeft een opdracht op die Get-Service de WinRM--service ophaalt. De parameter JobName geeft een gebruiksvriendelijke naam op voor de taak, WinRM. De parameter ThrottleLimit beperkt het aantal gelijktijdige opdrachten tot 16. Met de parameter AsJob wordt een achtergrondtaak gestart waarmee de opdracht op de servers wordt uitgevoerd.

In dit voorbeeld wordt informatie opgehaald over een taak en worden de resultaten weergegeven van een voltooide taak die is uitgevoerd op de lokale computer.

$j = Start-Job -ScriptBlock { Get-WinEvent -Log System } -Credential Domain01\User01
$j | Select-Object -Property *

State         : Completed
HasMoreData   : True
StatusMessage :
Location      : localhost
Command       : Get-WinEvent -Log System
JobStateInfo  : Completed
Finished      : System.Threading.ManualResetEvent
InstanceId    : 27ce3fd9-40ed-488a-99e5-679cd91b9dd3
Id            : 18
Name          : Job18
ChildJobs     : {Job19}
PSBeginTime   : 8/8/2019 14:41:57
PSEndTime     : 8/8/2019 14:42:07
PSJobTypeName : BackgroundJob
Output        : {}
Error         : {}
Progress      : {}
Verbose       : {}
Debug         : {}
Warning       : {}
Information   : {}

Start-Job gebruikt de parameter ScriptBlock om een opdracht uit te voeren waarmee Get-WinEvent wordt opgegeven om het System-logboek op te halen. De parameter Credential geeft een domeingebruikersaccount op met toestemming om de taak op de computer uit te voeren. Het taakobject wordt opgeslagen in de $j variabele.

Het object in de $j-variabele wordt naar Select-Objectverzonden. De parameter eigenschap geeft een sterretje (*) op om alle eigenschappen van het taakobject weer te geven.

In dit voorbeeld wordt een script op de lokale computer uitgevoerd als achtergrondtaak.

Start-Job -FilePath C:\Scripts\Sample.ps1

Start-Job gebruikt de parameter FilePath om een scriptbestand op te geven dat is opgeslagen op de lokale computer.

In dit voorbeeld wordt een achtergrondtaak gebruikt om een opgegeven proces op naam op te halen.

Start-Job -Name PShellJob -ScriptBlock { Get-Process -Name powershell }

Start-Job gebruikt de parameter Name om een beschrijvende taaknaam op te geven, PShellJob. De parameter ScriptBlock geeft Get-Process aan om processen op te halen met de naam powershell.

In dit voorbeeld wordt een taak gestart die een grote hoeveelheid kaartgegevens verzamelt en deze vervolgens opslaat in een .tif-bestand.

Start-Job -Name GetMappingFiles -InitializationScript {Import-Module -Name MapFunctions} -ScriptBlock {
   Get-Map -Name * | Set-Content -Path D:\Maps.tif }

Start-Job gebruikt de parameter Name om een beschrijvende taaknaam op te geven, GetMappingFiles. Met de parameter InitializationScript wordt een scriptblok uitgevoerd waarmee de module MapFunctions wordt geïmporteerd. De ScriptBlock parameter wordt uitgevoerd Get-Map en Set-Content slaat de gegevens op de door de parameter pad opgegeven locatie op.

In dit voorbeeld wordt de $input automatische variabele gebruikt om een invoerobject te verwerken. Gebruik Receive-Job om de uitvoer van de taak weer te geven.

Start-Job -ScriptBlock { Get-Content -Path $input } -InputObject "C:\Servers.txt"
Receive-Job -Name Job45 -Keep

Server01
Server02
Server03
Server04

Start-Job gebruikt de parameter ScriptBlock om Get-Content uit te voeren met de automatische variabele $input. Met de variabele $input worden objecten opgehaald uit de parameter InputObject. Receive-Job gebruikt de parameter Name om de taak op te geven en de resultaten uit te voeren. Met de parameter behouden wordt de taakuitvoer opgeslagen, zodat deze opnieuw kan worden weergegeven tijdens de PowerShell-sessie.

Met de WorkingDirectory kunt u een alternatieve map opgeven voor een taak waaruit u scripts kunt uitvoeren of bestanden kunt openen. In dit voorbeeld geeft de achtergrondtaak een werkmap op die anders is dan de huidige maplocatie.

PS C:\Test> Start-Job -WorkingDirectory C:\Test\Scripts { $PWD } | Receive-Job -AutoRemoveJob -Wait

Path
----
C:\Test\Scripts

De huidige werkmap van dit voorbeeld is C:\Test. Start-Job gebruikt de parameter WorkingDirectory om de werkmap van de taak op te geven. De parameter ScriptBlock gebruikt $PWD om de werkmap van de taak weer te geven. Receive-Job geeft de uitvoer van de achtergrondtaak weer. AutoRemoveJob verwijdert de taak en Wacht de opdrachtprompt onderdrukt totdat alle resultaten zijn ontvangen.

In dit voorbeeld wordt de parameter ArgumentList gebruikt om een matrix met argumenten op te geven. De matrix is een door komma's gescheiden lijst met procesnamen.

Start-Job -ScriptBlock { Get-Process -Name $args } -ArgumentList powershell, pwsh, notepad

Id     Name      PSJobTypeName   State       HasMoreData     Location     Command
--     ----      -------------   -----       -----------     --------     -------
1      Job1      BackgroundJob   Running     True            localhost    Get-Process -Name $args

De Start-Job-cmdlet gebruikt de parameter ScriptBlock om een opdracht uit te voeren. Get-Process gebruikt de parameter Name om de automatische variabele $argsop te geven. De parameter ArgumentList geeft de matrix met procesnamen door aan $args. De procesnamen powershell, pwsh en kladblok zijn processen die worden uitgevoerd op de lokale computer.

Gebruik de cmdlet Receive-Job om de uitvoer van de taak weer te geven. Bijvoorbeeld: Receive-Job -Id 1.

In dit voorbeeld wordt de parameter PSVersion met de waarde 5.1 gebruikt om een taak uit te voeren in een Windows PowerShell 5.1-sessie.

$PSVersionTable.PSVersion

Major  Minor  Patch  PreReleaseLabel BuildLabel
-----  -----  -----  --------------- ----------
7      0      0      rc.1

$job = Start-Job -ScriptBlock { $PSVersionTable.PSVersion } -PSVersion 5.1
Receive-Job -Job $job

Major  Minor  Build  Revision
-----  -----  -----  --------
5      1      14393  3383

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

U kunt een object doorsturen met de eigenschap Name naar de parameter Name van deze cmdlet. U kunt bijvoorbeeld een FileInfo--object uit Get-ChildItemdoorsluisen.

Deze cmdlet retourneert een PSRemotingJob object dat de taak vertegenwoordigt die is gestart.

PowerShell bevat de volgende aliassen voor Start-Job:

• Alle platforms:
  • sajb

Om op de achtergrond te draaien, draait Start-Job in een eigen sessie binnen de huidige sessie. Wanneer u de cmdlet Invoke-Command gebruikt om een Start-Job-opdracht uit te voeren in een sessie op een externe computer, wordt Start-Job uitgevoerd in een sessie in de externe sessie.