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>]

Командлет Start-Job запускает фоновое PowerShell-задание на локальном компьютере.

Фоновое задание PowerShell выполняет команду без взаимодействия с текущим сеансом. При запуске фонового задания объект задания возвращается немедленно, даже если для выполнения задания требуется более длительное время. Вы можете продолжать работать в сеансе без прерывания во время выполнения задания.

Объект задания содержит полезные сведения о задании, но он не содержит результаты задания. По завершении задания используйте командлет Receive-Job, чтобы получить результаты задания. Для получения дополнительной информации о фоновых заданиях см. раздел about_Jobs.

Чтобы запустить фоновое задание на удаленном компьютере, используйте параметр asJob, доступный во многих командлетах, или используйте командлет Invoke-Command для выполнения команды Start-Job на удаленном компьютере. Дополнительные сведения см. в разделе about_Remote_Jobs.

Начиная с PowerShell 3.0, Start-Job может запускать экземпляры пользовательских типов заданий, например, запланированные задания. Для получения информации о том, как использовать Start-Job для запуска заданий с пользовательскими типами, смотрите справочную документацию по функции типа задания.

Начиная с PowerShell 6.0, можно запустить задания с помощью фонового оператора ampersand (&). Функции фонового оператора похожи на Start-Job. Оба метода для запуска задания создают объект задания PSRemotingJob. Дополнительные сведения об использовании амперсанда (&) см. в about_Operators.

PowerShell 7 представила параметр WorkingDirectory, указывающий начальный рабочий каталог фонового задания. Если параметр не указан, Start-Job по умолчанию — это текущий рабочий каталог того, кто запустил задание.

В этом примере запускается фоновое задание, которое выполняется на локальном компьютере.

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 использует параметр ScriptBlock для запуска Get-Process в качестве фонового задания. Параметр имени используется для поиска процессов PowerShell pwsh. Отображаются сведения о задании, и PowerShell возвращает запрос во время выполнения задания в фоновом режиме.

Чтобы просмотреть выходные данные задания, используйте командлет Receive-Job. Например: Receive-Job -Id 1.

В этом примере используется оператор фона амперсанд (&), чтобы запустить фоновое задание на локальном компьютере. Задание получает тот же результат, что и Start-Job в примере 1.

Get-Process -Name pwsh &

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

Get-Process использует параметр Name для указания процессов PowerShell pwsh. Амперсанд (&) выполняет команду в качестве фонового задания. Отображаются сведения о задании, и PowerShell возвращает запрос во время выполнения задания в фоновом режиме.

Чтобы просмотреть выходные данные задания, используйте командлет Receive-Job. Например: Receive-Job -Id 5.

В этом примере выполняется задание на нескольких компьютерах. Задание хранится в переменной и выполняется с помощью имени переменной в командной строке PowerShell.

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

Задание, использующее Invoke-Command, создается и хранится в переменной $jobWRM. Invoke-Command использует параметр ComputerName, чтобы указать компьютеры, на которых выполняется задание. Get-Content получает имена серверов из файла C:\Servers.txt.

Параметр scriptBlock указывает команду, которая Get-Service получает службу WinRM. Параметр JobName задает дружественное имя задания, WinRM. Параметр ThrottleLimit ограничивает число параллельных команд до 16. Параметр AsJob запускает фоновое задание, которое запускает команду на серверах.

Этот пример получает сведения о задании и отображает результаты завершенного задания, выполняемого на локальном компьютере.

$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 использует параметр ScriptBlock для выполнения команды, указывающей Get-WinEvent для получения журнала System. Параметр учетных данных указывает учетную запись пользователя домена, которая имеет разрешение на выполнение задания на компьютере. Объект задания хранится в переменной $j.

Объект в переменной $j отправляется по конвейеру в Select-Object. Параметр свойства указывает звездочку (*) для отображения всех свойств объекта задания.

В этом примере скрипт на локальном компьютере выполняется в качестве фонового задания.

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

Start-Job использует параметр FilePath для указания файла скрипта, хранящегося на локальном компьютере.

В этом примере используется фоновое задание для получения указанного процесса по имени.

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

Start-Job использует параметр «Имя» , чтобы указать понятное имя задания PShellJob. Параметр scriptBlock указывает Get-Process для получения процессов с именем powershell.

В этом примере запускается задание, которое собирает большой объем данных карты, а затем сохраняет его в файле .tif.

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

Start-Job использует параметр , связанный с именем, для указания понятного имени задания GetMappingFiles. Параметр InitializationScript запускает блок скрипта, который импортирует модуль MapFunctions. Параметр ScriptBlock выполняет Get-Map и Set-Content сохраняет данные в расположении, указанном параметром пути.

В этом примере используется автоматическая переменная $input для обработки входного объекта. Используйте Receive-Job для просмотра выходных данных задания.

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

Server01
Server02
Server03
Server04

Start-Job использует параметр scriptBlock для выполнения Get-Content с помощью автоматической переменной $input. Переменная $input получает объекты из параметра InputObject. Receive-Job использует параметр Name для указания задания и вывода результатов. Параметр Keep сохраняет выходные данные задания, чтобы его можно было просмотреть еще раз во время сеанса PowerShell.

WorkingDirectory позволяет указать альтернативный каталог для задания, из которого можно запускать скрипты или открывать файлы. В этом примере фоновое задание указывает рабочий каталог, отличный от текущего расположения каталога.

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

Path
----
C:\Test\Scripts

Текущий рабочий каталог этого примера — C:\Test. Start-Job использует параметр WorkingDirectory для указания рабочего каталога задания. Параметр ScriptBlock использует $PWD для отображения рабочего каталога задания. Receive-Job отображает выходные данные фонового задания. AutoRemoveJob удаляет задание и Wait подавляет командную строку до получения всех результатов.

В этом примере используется параметр argumentList для указания массива аргументов. Массив представляет собой разделенный запятыми список имен процессов.

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

Командлет Start-Job использует параметр ScriptBlock для выполнения команды. Get-Process использует параметр с именем, чтобы указать автоматическую переменную $args. Параметр ArgumentList передает массив имен процессов $args. На локальном компьютере запущены процессы под именами powershell, pwsh и блокнот.

Чтобы просмотреть выходные данные задания, используйте командлет Receive-Job. Например: Receive-Job -Id 1.

В этом примере используется параметр PSVersion со значением 5.1 для выполнения задания в сеансе Windows PowerShell 5.1.

$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

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Объект можно передать в параметр Name этого командлета с помощью свойства Name. Например, можно перенаправить объект FileInfo из Get-ChildItem.

Этот командлет возвращает объект PSRemotingJob, представляющий запущенное задание.

PowerShell включает следующие псевдонимы для Start-Job:

• Все платформы:
  • sajb

Для выполнения в фоновом режиме Start-Job запускается в собственном сеансе в рамках текущего сеанса. При использовании командлета Invoke-Command для выполнения команды Start-Job в сеансе на удаленном компьютере Start-Job выполняется в удаленном сеансе.