Start-Job
启动 PowerShell 后台作业。
语法
Start-Job
[-Name <String>]
[-ScriptBlock] <ScriptBlock>
[-Credential <PSCredential>]
[-Authentication <AuthenticationMechanism>]
[[-InitializationScript] <ScriptBlock>]
[-RunAs32]
[-PSVersion <Version>]
[-InputObject <PSObject>]
[-ArgumentList <Object[]>]
[<CommonParameters>]
Start-Job
[-DefinitionName] <String>
[[-DefinitionPath] <String>]
[[-Type] <String>]
[<CommonParameters>]
Start-Job
[-Name <String>]
[-Credential <PSCredential>]
[-FilePath] <String>
[-Authentication <AuthenticationMechanism>]
[[-InitializationScript] <ScriptBlock>]
[-RunAs32]
[-PSVersion <Version>]
[-InputObject <PSObject>]
[-ArgumentList <Object[]>]
[<CommonParameters>]
Start-Job
[-Name <String>]
[-Credential <PSCredential>]
-LiteralPath <String>
[-Authentication <AuthenticationMechanism>]
[[-InitializationScript] <ScriptBlock>]
[-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>]
说明
cmdlet Start-Job
在本地计算机上启动 PowerShell 后台作业。
PowerShell 后台作业在不与当前会话交互的情况下运行命令。 启动后台作业后,即使后台作业需要较长时间才能完成,系统也会立即返回一个作业对象。 当该作业运行时,你可以继续在此会话中工作而不会发生中断。
作业对象包含有关作业的有用信息,但它不包含作业结果。
作业完成后,使用 Receive-Job
cmdlet 获取作业结果。 有关后台作业的详细信息,请参阅 about_Jobs。
若要在远程计算机上运行后台作业,请使用在许多 cmdlet 上可用的 AsJob 参数,或使用 Invoke-Command
cmdlet 在远程计算机上运行 Start-Job
命令。 有关详细信息,请参阅 about_Remote_Jobs。
从 PowerShell 3.0 开始, Start-Job
可以启动自定义作业类型的实例,例如计划作业。 有关如何使用 Start-Job
自定义类型启动作业的信息,请参阅作业类型功能的帮助文档。
示例
示例 1:启动后台作业
此示例启动在本地计算机上后台运行的作业。
Start-Job -ScriptBlock {Get-Process}
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
1 Job1 BackgroundJob Running True localhost Get-Process
Start-Job
使用 ScriptBlock 参数作为后台作业运行 Get-Process
。 作业信息随即显示,当作业在后台运行时,PowerShell 会返回到提示符。
示例 2:使用 Invoke-Command 启动作业
此示例在多台计算机上运行作业。 作业存储在变量中,并使用 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 参数指定获取 WinRM 服务的命令Get-Service
。 JobName 参数指定作业的友好名称 WinRM。 ThrottleLimit 参数将并发命令数限制为 16。 AsJob 参数启动在服务器上运行命令的后台作业。
示例 3:获取作业信息
此示例获取有关作业的信息,并显示在本地计算机上运行的已完成作业的结果。
$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
获取 系统 日志的命令。 Credential 参数指定有权在计算机上运行作业的域用户帐户。 作业对象存储在 变量中 $j
。
变量中的 $j
对象在管道 Select-Object
中向下发送到 。 Property 参数指定一个星号 (*
) 以显示作业对象的所有属性。
示例 4:将脚本作为后台作业运行
在此示例中,本地计算机上的脚本作为后台作业运行。
Start-Job -FilePath C:\Scripts\Sample.ps1
Start-Job
使用 FilePath 参数指定存储在本地计算机上的脚本文件。
示例 5:使用后台作业获取进程
此示例使用后台作业按名称获取指定的进程。
Start-Job -Name PShellJob -ScriptBlock { Get-Process -Name PowerShell }
Start-Job
使用 Name 参数指定友好的作业名称 PShellJob。 ScriptBlock 参数指定Get-Process
获取名为 PowerShell 的进程。
示例 6:使用后台作业收集和保存数据
此示例启动一个收集大量地图数据的作业,然后将其保存在文件中 .tif
。
Start-Job -Name GetMappingFiles -InitializationScript {Import-Module MapFunctions} -ScriptBlock {
Get-Map -Name * | Set-Content -Path D:\Maps.tif } -RunAs32
Start-Job
使用 Name 参数指定友好的作业名称 GetMappingFiles。 InitializationScript 参数运行导入 MapFunctions 模块的脚本块。 ScriptBlock 参数运行Get-Map
并将Set-Content
数据保存在 Path 参数指定的位置。 RunAs32 参数以 32 位的形式运行进程,即使在 64 位操作系统上也是如此。
示例 7:将输入传递到后台作业
此示例使用 $input
自动变量来处理输入对象。 使用 Receive-Job
查看作业的输出。
Start-Job -ScriptBlock { Get-Content $input } -InputObject "C:\Servers.txt"
Receive-Job -Name Job45 -Keep
Server01
Server02
Server03
Server04
Start-Job
使用 ScriptBlock 参数与自动变量一起$input
运行Get-Content
。 变量 $input
从 InputObject 参数获取对象。 Receive-Job
使用 Name 参数指定作业并输出结果。 Keep 参数保存作业输出,以便在 PowerShell 会话期间再次查看。
参数
-ArgumentList
为 FilePath 参数指定的脚本指定参数或参数值的数组。
由于 ArgumentList 参数名称后面的所有值都解释为 ArgumentList 的值,因此请将此参数指定为命令中的最后一个参数。
Type: | Object[] |
Aliases: | Args |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Authentication
指定用于对用户凭据进行身份验证的机制。
此参数的可接受值如下所示:
- Default
- 基本
- Credssp
- 摘要
- Kerberos
- Negotiate
- NegotiateWithImplicitCredential
默认值为 Default。
CredSSP 身份验证仅在 Windows Vista、Windows Server 2008 和更高版本的 Windows 操作系统中可用。
有关此参数的值的详细信息,请参阅 AuthenticationMechanism。
注意
在凭据安全支持提供程序 (CredSSP) 身份验证中,用户凭据传递到远程计算机中以进行验证,这种验证用于要求对多个资源(例如访问远程网络共享)进行验证的命令。 此机制增加了远程操作的安全风险。 如果远程计算机的安全受到威胁,则传递给该计算机的凭据可用于控制网络会话。
Type: | AuthenticationMechanism |
Accepted values: | Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos |
Position: | Named |
Default value: | Default |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
指定有权执行此操作的用户帐户。 如果未指定 Credential 参数,则命令将使用当前用户的凭据。
键入用户名(如 User01 或 Domain01\User01),或输入 PSCredential 对象,例如 cmdlet 中的 Get-Credential
一个对象。
Type: | PSCredential |
Position: | Named |
Default value: | Current user |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefinitionName
指定此 cmdlet 启动的作业的定义名称。 使用此参数来启动具有定义名称的自定义作业,例如计划作业。
使用 Start-Job
启动计划作业的实例时,无论作业触发器或作业选项如何,作业都会立即启动。 生成的作业实例是计划作业,但它不会像触发的计划作业一样保存到磁盘。 不能使用 的 ArgumentList 参数 Start-Job
为在计划作业中运行的脚本的参数提供值。 有关详细信息,请参阅 about_Scheduled_Jobs。
此参数是在 PowerShell 3.0 中引入的。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefinitionPath
指定此 cmdlet 启动的作业的定义路径。 输入定义路径。 DefinitionPath 和 DefinitionName 参数的值串联是作业定义的完全限定路径。 使用此参数来启动具有定义路径的自定义作业,例如计划作业。
对于计划作业, DefinitionPath 参数 $home\AppData\Local\Windows\PowerShell\ScheduledJob
的值为 。
此参数是在 PowerShell 3.0 中引入的。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FilePath
指定作为后台作业运行的本地脚本 Start-Job
。 输入脚本的路径和文件名,或使用管道将脚本路径 Start-Job
发送到 。 脚本必须位于本地计算机或本地计算机可以访问的文件夹中。
使用此参数时,PowerShell 会将指定脚本文件的内容转换为脚本块,并将脚本块作为后台作业运行。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InitializationScript
指定在作业开始前运行的命令。 若要创建脚本块,请将命令括在大括号 ({}
) 。
使用此参数可以准备运行作业的会话。 例如,可以使用它将函数、管理单元和模块添加到会话中。
Type: | ScriptBlock |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
指定命令的输入。 请输入包含对象的变量,或者键入可生成对象的命令或表达式。
在 ScriptBlock 参数的值中 $input
,使用自动变量表示输入对象。
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
指定此 cmdlet 作为后台作业运行的本地脚本。 输入本地计算机上的脚本路径。
Start-Job
使用 LiteralPath 参数的值与键入时完全相同。 不会将任何字符解释为通配字符。 如果路径包括转义符,请将其括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。
Type: | String |
Aliases: | PSPath |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
为新作业指定一个友好名称。 可以使用 名称向其他作业 cmdlet(如 cmdlet) Stop-Job
标识作业。
默认的友好名称为 Job#
,其中 #
是为每个作业递增的序号。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PSVersion
指定版本。 Start-Job
使用 PowerShell 版本运行作业。 此参数的可接受值为: 2.0
和 3.0
。
此参数是在 PowerShell 3.0 中引入的。
Type: | Version |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RunAs32
指示 Start-Job
在 32 位进程中运行作业。 RunAs32 强制作业在 32 位进程中运行,即使在 64 位操作系统上也是如此。
在 64 位版本的 Windows 7 和 Windows Server 2008 R2 上 Start-Job
,当命令包含 RunAs32 参数时,不能使用 Credential 参数指定其他用户的凭据。
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ScriptBlock
指定要在后台作业中运行的命令。 若要创建脚本块,请将命令括在大括号 ({}
) 。 $input
使用自动变量访问 InputObject 参数的值。 此参数是必需的。
Type: | ScriptBlock |
Aliases: | Command |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Type
指定由 启动的作业的 Start-Job
自定义类型。 输入自定义作业类型名称,例如 PSScheduledJob(对于计划作业)或 PSWorkflowJob(对于工作流作业)。 此参数对标准后台作业无效。
此参数是在 PowerShell 3.0 中引入的。
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
输入
可以使用管道将具有 Name 属性的对象发送到 Name 参数。 例如,可以将 FileInfo 对象从 Get-ChildItem
管道传递给 Start-Job
。
输出
System.Management.Automation.PSRemotingJob
Start-Job
返回一个 PSRemotingJob 对象,该对象表示它启动的作业。
备注
若要在后台运行,请在 Start-Job
当前会话中的自己的会话中运行。 使用 Invoke-Command
cmdlet 在远程计算机上的会话中运行 Start-Job
命令时, Start-Job
在远程会话的会话中运行。