Debug-Job

  • 参考
模块:
Microsoft.PowerShell.Core

调试正在运行的后台或远程作业。

语法

Debug-Job
     [-Job] <Job>
     [-BreakAll]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Debug-Job
     [-Name] <String>
     [-BreakAll]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Debug-Job
     [-Id] <Int32>
     [-BreakAll]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Debug-Job
     [-InstanceId] <Guid>
     [-BreakAll]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

说明

Debug-Job cmdlet 允许调试正在作业中运行的脚本。 该 cmdlet 旨在调试 PowerShell 工作流作业、后台作业，以及正在远程会话中运行的作业。 Debug-Job 接受正在运行的作业对象、名称、ID 或实例 ID 作为输入，并在正在运行的脚本上启动调试会话。 调试程序 quit 命令停止作业和正在运行的脚本。 exit 命令分离调试程序，并允许作业继续运行。

示例

示例 1：按作业 ID 调试作业

此命令强行进入 ID 为 3 的正在运行的作业。

Debug-Job -ID 3

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
3      Job3            RemoteJob       Running       True            PowerShellIx         TestWFDemo1.ps1
          Entering debug mode. Use h or ? for help.

          Hit Line breakpoint on 'C:\TestWFDemo1.ps1:8'

          At C:\TestWFDemo1.ps1:8 char:5
          +     Write-Output -InputObject "Now writing output:"
          +     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
          [DBG:PowerShellIx]: PS C:\> > list

              3:
              4:  workflow SampleWorkflowTest
              5:  {
              6:      param ($MyOutput)
              7:
              8:*     Write-Output -InputObject "Now writing output:"
              9:      Write-Output -Input $MyOutput
             10:
             11:      Write-Output -InputObject "Get PowerShell process:"
             12:      Get-Process -Name powershell
             13:
             14:      Write-Output -InputObject "Workflow function complete."
             15:  }
             16:
             17:  # Call workflow function
             18:  SampleWorkflowTest -MyOutput "Hello"

参数

-BreakAll

允许在调试程序附加时立即在当前位置中断。

此参数已在 PowerShell 7.2 中添加。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

指定正在运行的作业的 ID 号。 若要获取作业的 ID 号，请运行 Get-Job cmdlet。

Type:Int32
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InstanceId

指定正在运行的作业的实例 ID GUID。

Type:Guid
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Job

指定正在运行的作业对象。 使用此参数最简单的方法是，保存 Get-Job 命令（此命令可返回要在某个变量中调试的正在运行的作业）的结果，然后将该变量指定为此参数的值。

Type:Job
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

通过作业的易记名称指定作业。 启动作业时，可以通过在 cmdlet（例如 Invoke-Command 和 Start-Job）中添加 JobName 参数来指定作业名称。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

System.Management.Automation.RemotingJob