Start-ThreadJob
创建类似于 cmdlet 的 Start-Job 后台作业。
语法
Start-ThreadJob
[-ScriptBlock] <ScriptBlock>
[-Name <String>]
[-InitializationScript <ScriptBlock>]
[-InputObject <PSObject>]
[-ArgumentList <Object[]>]
[-ThrottleLimit <Int32>]
[-StreamingHost <PSHost>]
[<CommonParameters>] Start-ThreadJob
[-FilePath] <String>
[-Name <String>]
[-InitializationScript <ScriptBlock>]
[-InputObject <PSObject>]
[-ArgumentList <Object[]>]
[-ThrottleLimit <Int32>]
[-StreamingHost <PSHost>]
[<CommonParameters>] 说明
Start-ThreadJob 创建类似于 cmdlet 的 Start-Job 后台作业。 主要区别在于，在本地进程中的单独线程中创建的作业在单独的线程中运行。 默认情况下，作业使用启动作业的调用方当前工作目录。
该 cmdlet 还支持 ThrottleLimit 参数来限制一次运行的作业数。 随着更多作业的启动，作业已排队，并等待当前作业数低于限制限制。
示例
示例 1 - 创建线程限制为 2 的后台作业
Start-ThreadJob -ScriptBlock { 1..100 | % { sleep 1; "Output $_" } } -ThrottleLimit 2
Start-ThreadJob -ScriptBlock { 1..100 | % { sleep 1; "Output $_" } }
Start-ThreadJob -ScriptBlock { 1..100 | % { sleep 1; "Output $_" } }
Get-Job
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
1 Job1 ThreadJob Running True PowerShell 1..100 | % { sleep 1;...
2 Job2 ThreadJob Running True PowerShell 1..100 | % { sleep 1;...
3 Job3 ThreadJob NotStarted False PowerShell 1..100 | % { sleep 1;...示例 2 - 比较Start-Job和Start-ThreadJob的性能
此示例显示了两Start-ThreadJob者之间的差异Start-Job。 作业运行 Start-Sleep cmdlet 1 秒。 由于作业并行运行，因此总执行时间约为 1 秒，以及创建作业所需的任何时间。
# start five background jobs each running 1 second
Measure-Command {1..5 | % {Start-Job {Start-Sleep 1}} | Wait-Job} | Select-Object TotalSeconds
Measure-Command {1..5 | % {Start-ThreadJob {Start-Sleep 1}} | Wait-Job} | Select-Object TotalSeconds
TotalSeconds
------------
5.7665849
1.5735008在执行时间减去 1 秒后，可以看到创建 Start-Job 五个作业大约需要 4.8 秒。 Start-ThreadJob 快 8 倍，创建 5 个作业大约需要 0.6 秒。 结果在环境中可能会有所不同，但相对改进应相同。
示例 3 - 使用 InputObject 创建作业
在此示例中，脚本块使用 $input 变量从 InputObject 参数接收输入。 也可以通过管道对象来完成 Start-ThreadJob此操作。
$j = Start-ThreadJob -InputObject (Get-Process pwsh) -ScriptBlock { $input | Out-String }
$j | Wait-Job | Receive-Job
NPM(K) PM(M) WS(M) CPU(s) Id SI ProcessName
------ ----- ----- ------ -- -- -----------
94 145.80 159.02 18.31 18276 1 pwsh
101 163.30 222.05 29.00 35928 1 pwsh
$j = Get-Process pwsh | Start-ThreadJob -ScriptBlock { $input | Out-String }
$j | Wait-Job | Receive-Job
NPM(K) PM(M) WS(M) CPU(s) Id SI ProcessName
------ ----- ----- ------ -- -- -----------
94 145.80 159.02 18.31 18276 1 pwsh
101 163.30 222.05 29.00 35928 1 pwsh示例 4 - 将作业输出流式传输到父主机
使用 StreamingHost 参数，可以告知作业将所有主机输出定向到特定主机。 如果没有此参数，输出将转到作业数据流集合，在收到作业输出之前不会显示在主机控制台中。
对于此示例，当前主机将使用$Host自动变量传递给Start-ThreadJob该主机。
PS> Start-ThreadJob -ScriptBlock { Read-Host 'Say hello'; Write-Warning 'Warning output' } -StreamingHost $Host
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
7 Job7 ThreadJob NotStarted False PowerShell Read-Host 'Say hello'; ...
PS> Say hello: Hello
WARNING: Warning output
PS> Receive-Job -Id 7
Hello
WARNING: Warning output
PS>请注意，将显示来自 Read-Host 的提示，并且你能够键入输入。 然后，将显示来自 Write-Warning 的消息。 Receive-Job该 cmdlet 返回作业中的所有输出。
参数
-ArgumentList
为 FilePath 或 ScriptBlock 参数指定的脚本指定参数数组或参数值。
ArgumentList 必须是命令行上的最后一个参数。 参数名称后面的所有值都是参数列表中的解释值。
| Type: | Object[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilePath
指定要作为后台作业运行的脚本文件。 输入脚本的路径和文件名。 该脚本必须位于本地计算机或本地计算机可以访问的文件夹中。
使用此参数时，PowerShell 会将指定脚本文件的内容转换为脚本块，并将脚本块作为后台作业运行。
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InitializationScript
指定在作业开始前运行的命令。 将命令括在大括号 ({}) 以创建脚本块。
使用此参数可以准备运行作业的会话。 例如，可以使用它向会话添加函数和模块。
| Type: | ScriptBlock |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
指定用作脚本块输入的对象。 它还允许管道输入。 $input使用脚本块中的自动变量访问输入对象。
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
为新作业指定一个友好名称。 可以使用名称将作业标识为其他作业 cmdlet，例如 Stop-Job cmdlet。
默认友好名称为“Job#”，其中“#”是每个作业递增的序号。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScriptBlock
指定要在后台作业中运行的命令。 将命令括在大括号 ({}) 以创建脚本块。 $Input使用自动变量访问 InputObject 参数的值。 此参数是必需的。
| Type: | ScriptBlock |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StreamingHost
此参数提供了一种线程安全的方式，允许 Write-Host 输出直接转到 传入的 PSHost 对象。 如果没有它， Write-Host 输出将转到作业信息数据流集合，在作业完成运行之前不会显示在主机控制台中。
| Type: | PSHost |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ThrottleLimit
此参数限制一次运行的作业数。 启动作业时，会排队等待线程在线程池中可用以运行作业。 默认限制为 5 个线程。
线程池大小对于 PowerShell 会话是全局的。 在一个调用中指定 ThrottleLimit 可设置同一会话中后续调用的限制。
| Type: | Int32 |
| Position: | Named |
| Default value: | 5 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
输入
输出
ThreadJob.ThreadJob