Start-Job

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

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

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

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

Start-Job
    [-VMGuid] <Guid[]>
    [<CommonParameters>]

Start-Job
    [-VMGuid] <Guid[]>
    [<CommonParameters>]

Start-Job
    -VMName <String[]>
    [<CommonParameters>]

Start-Job
    -VMName <String[]>
    [<CommonParameters>]

L’applet de commande Start-Job démarre un travail en arrière-plan PowerShell sur l’ordinateur local.

Un travail en arrière-plan PowerShell exécute une commande sans interagir avec la session active. Lorsque vous démarrez un travail en arrière-plan, un objet de travail retourne immédiatement, même si le travail prend un certain temps pour se terminer. Vous pouvez continuer à travailler dans la session sans interruption pendant l'exécution de la tâche.

L’objet de travail contient des informations utiles sur le travail, mais il ne contient pas les résultats du travail. Une fois le travail terminé, utilisez l’applet de commande Receive-Job pour obtenir les résultats du travail. Pour plus d’informations sur les tâches en arrière-plan, consultez about_Jobs.

Pour exécuter un travail en arrière-plan sur un ordinateur distant, utilisez le paramètre AsJob disponible sur de nombreuses applets de commande ou utilisez l’applet de commande Invoke-Command pour exécuter une commande Start-Job sur l’ordinateur distant. Pour plus d’informations, consultez about_Remote_Jobs.

À compter de PowerShell 3.0, Start-Job pouvez démarrer des instances de types de travaux personnalisés, telles que des travaux planifiés. Pour plus d’informations sur l’utilisation de Start-Job pour démarrer des travaux avec des types personnalisés, consultez les documents d’aide pour la fonctionnalité de type de travail.

Cet exemple démarre un travail qui s’exécute en arrière-plan sur l’ordinateur local.

Start-Job -ScriptBlock {Get-Process}

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

Start-Job utilise le paramètre ScriptBlock pour exécuter Get-Process en tant que travail en arrière-plan. Les informations sur le travail sont affichées et PowerShell retourne à une invite pendant que le travail s’exécute en arrière-plan.

Cet exemple exécute un travail sur plusieurs ordinateurs. Le travail est stocké dans une variable et est exécuté à l’aide du nom de la variable sur la ligne de commande PowerShell.

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

Un travail qui utilise Invoke-Command est créé et stocké dans la variable $jobWRM. Invoke-Command utilise le paramètre ComputerName pour spécifier les ordinateurs sur lesquels le travail s’exécute. Get-Content obtient les noms du serveur à partir du fichier C:\Servers.txt.

Le paramètre ScriptBlock spécifie une commande qui Get-Service obtient le service WinRM. Le paramètre JobName spécifie un nom convivial pour la tâche, WinRM. Le paramètre ThrottleLimit limite le nombre de commandes simultanées à 16. Le paramètre AsJob démarre un travail en arrière-plan qui exécute la commande sur les serveurs.

Cet exemple obtient des informations sur un travail et affiche les résultats d’un travail terminé qui a été exécuté sur l’ordinateur local.

$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 utilise le paramètre ScriptBlock pour exécuter une commande qui spécifie Get-WinEvent pour obtenir le journal du système. Le paramètre Credential spécifie un compte d’utilisateur de domaine avec l’autorisation d’exécuter le travail sur l’ordinateur. L’objet de travail est stocké dans la variable $j.

L’objet de la variable $j est envoyé dans le pipeline jusqu’à Select-Object. Le paramètre Property spécifie un astérisque (*) pour afficher toutes les propriétés de l’objet de travail.

Dans cet exemple, un script sur l’ordinateur local est exécuté en tant que travail en arrière-plan.

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

Start-Job utilise le paramètre FilePath pour spécifier un fichier de script stocké sur l’ordinateur local.

Cet exemple utilise un travail en arrière-plan pour obtenir un processus spécifié par son nom.

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

Start-Job utilise le paramètre Name pour spécifier un nom de travail convivial PShellJob. Le paramètre ScriptBlock spécifie Get-Process pour obtenir des processus portant le nom PowerShell.

Cet exemple démarre un travail qui collecte une grande quantité de données cartographiques, puis l’enregistre dans un fichier .tif.

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

Start-Job utilise le paramètre Name pour spécifier un nom de travail convivial, GetMappingFiles. Le paramètre InitializationScript exécute un bloc de script qui importe le module MapFunctions. Le paramètre ScriptBlock s’exécute Get-Map et Set-Content enregistre les données à l’emplacement spécifié par le paramètre Path. Le paramètre RunAs32 exécute le processus en tant que 32 bits, même sur un système d’exploitation 64 bits.

Cet exemple utilise la variable automatique $input pour traiter un objet d’entrée. Utilisez Receive-Job pour afficher le résultat de la tâche.

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

Server01
Server02
Server03
Server04

Start-Job utilise le paramètre ScriptBlock pour exécuter Get-Content avec la variable automatique $input. La variable $input obtient des objets du paramètre InputObject. Receive-Job utilise le paramètre Name pour spécifier le travail et générer les résultats. Le paramètre Keep enregistre le résultat du travail afin qu’il puisse être consulté à nouveau pendant la session PowerShell.

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Vous pouvez utiliser le pipeline pour envoyer un objet avec la propriété Name au paramètre Name . Par exemple, vous pouvez canaliser un objet FileInfo de Get-ChildItem à Start-Job.

Start-Job renvoie un objet PSRemotingJob qui représente le travail qu’il a démarré.

Pour s’exécuter en arrière-plan, Start-Job s’exécute dans sa propre session au sein de la session actuelle. Lorsque vous utilisez l’applet de commande Invoke-Command pour exécuter une commande Start-Job dans une session sur un ordinateur distant, Start-Job s’exécute dans une session dans la session à distance.