次の方法で共有

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 コマンドレットを使用すると、ジョブ内で実行されているスクリプトをデバッグできます。 このコマンドレットは、リモート セッションで実行されている 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 で追加されました。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Id

実行中のジョブの ID 番号を指定します。 ジョブの ID 番号を取得するには、 Get-Job コマンドレットを実行します。

型:Int32
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InstanceId

実行中のジョブのインスタンス ID GUID を指定します。

型:Guid
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Job

実行中のジョブ オブジェクトを指定します。 このパラメーターを使用する最も簡単な方法は、デバッグする実行中のジョブを返す Get-Job コマンドの結果を変数に保存し、変数をこのパラメーターの値として指定することです。

型:Job
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

ジョブのフレンドリ名でジョブを指定します。 ジョブを開始するときに、Invoke-CommandやStart-Jobなどのコマンドレットに JobName パラメーターを追加することで、ジョブ名を指定できます。

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

System.Management.Automation.RemotingJob