次の方法で共有

デバッガについて

概要

PowerShell デバッガーについて説明します。

詳細説明

デバッグとは、スクリプトの実行中にスクリプトを調べて、スクリプト命令のエラーを特定して修正するプロセスです。 PowerShell デバッガーは、スクリプト、関数、コマンド、PowerShell ワークフロー、PowerShell Desired State Configuration (DSC) 構成、または式のエラーと非効率性を調査して特定するのに役立ちます。

PowerShell 5.0 以降、PowerShell デバッガーは、リモート コンピューター上のコンソールまたは Windows PowerShell ISE で実行されているスクリプト、関数、ワークフロー、コマンド、構成、または式をデバッグするために更新されました。 Enter-PSSession を実行して、リモート コンピューターでブレークポイントを設定したり、スクリプト ファイルやコマンドをデバッグしたりできる対話型のリモート PowerShell セッションを開始できます。 Enter-PSSession 機能が更新され、リモート コンピューター上でスクリプトまたはコマンドを実行している切断されたセッションに再接続して参加できるようになりました。 実行中のスクリプトがブレークポイントにヒットすると、クライアント セッションによってデバッガーが自動的に開始されます。 スクリプトを実行している切断セッションが既にブレークポイントにヒットしており、ブレークポイントで停止している場合、セッションに再接続すると、 Enter-PSSession によってコマンド ライン デバッガーが自動的に開始されます。

PowerShell デバッガーは、PowerShell コンソールまたは Windows PowerShell ISE で PowerShell ワークフローをデバッグするためにも使用できます。 PowerShell 5.0 以降では、実行中のジョブまたはプロセス内で、ローカルまたはリモートでデバッグできます。

PowerShell デバッガーの機能を使用して、PowerShell スクリプト、関数、コマンド、ワークフロー、または式の実行中にその内容を調べることができます。 PowerShell デバッガーには、ブレークポイントの設定、ブレークポイントの管理、呼び出し履歴の表示を行うことができる一連のコマンドレットが含まれています。

デバッガー コマンドレット

PowerShell デバッガーには、次のコマンドレットのセットが含まれています。

  • Set-PSBreakpoint: 行、変数、およびコマンドにブレークポイントを設定します。
  • Get-PSBreakpoint: 現在のセッションのブレークポイントを取得します。
  • Disable-PSBreakpoint: 現在のセッションのブレークポイントをオフにします。
  • Enable-PSBreakpoint: 現在のセッションでブレークポイントを再度有効にします。
  • Remove-PSBreakpoint: 現在のセッションからブレークポイントを削除します。
  • Get-PSCallStack: 現在の呼び出し履歴を表示します。

デバッガーの起動と停止

デバッガーを起動するには、1 つ以上のブレークポイントを設定します。 次に、デバッグするスクリプト、コマンド、または関数を実行します。

ブレークポイントに到達すると、実行が停止し、制御がデバッガーに引き継がれます。

デバッガーを停止するには、スクリプト、コマンド、または関数を完了するまで実行します。 または、「stop または t」と入力します。

デバッガー コマンド

PowerShell コンソールでデバッガーを使用する場合は、次のコマンドを使用して実行を制御します。 Windows PowerShell ISE で、[デバッグ] メニューのコマンドを使用します。

注: 他のホスト・アプリケーションでデバッガーを使用する方法については、ホスト・アプリケーションの資料を参照してください。

  • s、StepInto: 次のステートメントを実行してから停止します。

  • v、StepOver: 次のステートメントを実行しますが、関数と呼び出しはスキップします。 スキップされたステートメントは実行されますが、ステップ スルーされません。

  • Ctrl+Break: (ISE ですべて中断) PowerShell コンソールまたは Windows PowerShell ISE 内で実行中のスクリプトに分割します。 Windows PowerShell 2.0、3.0、4.0 Ctrl+Break はプログラムを閉じます。 Break All は、ローカルスクリプトとリモートスクリプトの両方で動作します。

  • o、 StepOut: 現在の関数からステップアウトします。入れ子になっている場合は、1 レベル上に上げます。 本体内にある場合は、末尾または次のブレークポイントに進みます。 スキップされたステートメントは実行されますが、ステップ スルーされません。

  • c、Continue: スクリプトが完了するか、次のブレークポイントに達するまで実行を続行します。 スキップされたステートメントは実行されますが、ステップ スルーされません。

  • l、 List: スクリプトの実行中の一部が表示されます。 既定では、現在の行、前の 5 行、および 10 行が表示されます。 スクリプトの一覧を表示するには、Enter キーを押します。

  • l <m>, List: <m>で指定された行番号で始まるスクリプトの 16 行を表示します。

  • l <m> <n>, List: <n>で指定された行番号から始まるスクリプトの <m> 行を表示します。

  • q、Stop、Exit: スクリプトの実行を停止し、デバッガーを終了します。 Debug-Job コマンドレットを実行してジョブをデバッグする場合、Exit コマンドはデバッガーをデタッチし、ジョブの実行を続行できるようにします。

  • k、Get-PsCallStack: 現在の呼び出し履歴を表示します。

  • <Enter>: 最後のコマンドがステップ (s)、ステップ オーバー (v)、またはリスト (l) の場合は、それを繰り返します。 それ以外の場合は、送信アクションを表します。

  • ?、h: デバッガー コマンドのヘルプを表示します。

デバッガを終了するには、Stop (q) を使用します。

PowerShell 5.0 以降では、Exit コマンドを実行して、Debug-Job または Debug-Runspaceを実行して開始した入れ子になったデバッグ セッションを終了できます。

これらのデバッガー コマンドを使用すると、スクリプトを実行し、懸念事項で停止し、変数の値とシステムの状態を調べ、問題を特定するまでスクリプトの実行を続行できます。

注: ">" などのリダイレクト演算子を使用してステートメントにステップ インすると、PowerShell デバッガーはスクリプト内の残りのすべてのステートメントをステップ オーバーします。

スクリプト変数の値の表示

デバッガーの実行中は、コマンドを入力したり、変数の値を表示したり、コマンドレットを使用したり、コマンド ラインでスクリプトを実行したりすることもできます。

デバッグ中のスクリプト内のすべての変数の現在の値を表示できます。ただし、次の自動変数は除きます。

$_
$Args
$Input
$MyInvocation
$PSBoundParameters

これらの変数のいずれかの値を表示しようとすると、スクリプト内の変数の値ではなく、デバッガーが使用する内部パイプライン内のその変数の値が表示されます。

デバッグ中のスクリプトのこれらの変数の値を表示するには、スクリプトで、自動変数の値を新しい変数に割り当てます。 その後、新しい変数の値を表示できます。

たとえば、

$scriptArgs = $Args
$scriptArgs

このトピックの例では、 $MyInvocation 変数の値が次のように再割り当てされます。

$scriptname = $MyInvocation.MyCommand.Path

デバッガー環境

ブレークポイントに到達すると、デバッガー環境に入ります。 コマンド プロンプトが "[DBG]:" で始まるよう変更されます。 ワークフローをデバッグしている場合、プロンプトは "[WFDBG]" です。 プロンプトをカスタマイズできます。

プロンプトのカスタマイズの詳細については、about_Promptsを参照してください。

また、PowerShell コンソールなどの一部のホスト アプリケーション (Windows PowerShell Integrated Scripting Environment (ISE)) では、デバッグのために入れ子になったプロンプトが開きます。 入れ子になったプロンプトは、コマンド プロンプトに表示される繰り返し大きい文字 (ASCII 62) で検出できます。

たとえば、PowerShell コンソールの既定のデバッグ プロンプトを次に示します。

[DBG]: PS (get-location)>>>

$NestedPromptLevel 自動変数を使用して、入れ子レベルを見つけることができます。

さらに、自動変数 $PSDebugContext がローカル スコープで定義されます。 $PsDebugContext変数の存在を使用して、デバッガーを使用しているかどうかを判断できます。

例えば次が挙げられます。

if ($PSDebugContext) {"Debugging"} else {"Not Debugging"}

デバッグでは、$PSDebugContext 変数の値を使用できます。

[DBG]: PS>>> $PSDebugContext.InvocationInfo

Name   CommandLineParameters  UnboundArguments  Location
----   ---------------------  ----------------  --------
=      {}                     {}                C:\ps-test\vote.ps1 (1)

デバッグとスコープ

デバッガーに割り込んでも、操作しているスコープは変更されませんが、スクリプト内のブレークポイントに達すると、スクリプトのスコープに移動します。 スクリプト スコープは、デバッガーを実行したスコープの子です。

スクリプト スコープで定義されている変数とエイリアスを検索するには、Get-Alias または Get-Variable コマンドレットの Scope パラメーターを使用します。

たとえば、次のコマンドは、ローカル (スクリプト) スコープ内の変数を取得します。

Get-Variable -scope 0

コマンドは次のように省略できます。

gv -s 0

これは、スクリプトで定義した変数と、デバッグ中に定義した変数のみを表示する便利な方法です。

コマンドラインでのデバッグ

変数ブレークポイントまたはコマンド ブレークポイントを設定する場合は、スクリプト ファイル内でのみブレークポイントを設定できます。 ただし、既定では、ブレークポイントは現在のセッションで実行されるすべてのものに設定されます。

たとえば、$name 変数にブレークポイントを設定すると、ブレークポイントを無効または削除するまで、実行したスクリプト、コマンド、関数、スクリプト コマンドレット、または式内の任意の $name 変数でデバッガーが中断されます。

これにより、より現実的なコンテキストでスクリプトをデバッグできます。このコンテキストでは、セッションおよびユーザーのプロファイル内の関数、変数、およびその他のスクリプトの影響を受ける可能性があります。

行ブレークポイントはスクリプト ファイルに固有であるため、スクリプト ファイルでのみ設定されます。

ワークフローのデバッグ

PowerShell 4.0 デバッガーを使用して、PowerShell コンソールまたは Windows PowerShell ISE で PowerShell ワークフローをデバッグできます。 PowerShell デバッガーを使用してワークフローをデバッグする場合には、いくつかの制限があります。

  • デバッガ内でワークフロー変数を表示することはできますが、デバッガ内からのワークフロー変数の設定はサポートされていません。
  • ワークフローデバッガーで停止したタブ補完は使用できません。
  • ワークフロー デバッグは、PowerShell スクリプトからのワークフローの同期実行でのみ機能します。 ワークフローがジョブとして実行されている場合 ( AsJob パラメーターを使用) はデバッグできません。
  • ワークフローが別のワークフローを呼び出す、ワークフローがスクリプトを呼び出すなど、他の入れ子になったデバッグ シナリオは実装されません。

次の例では、ワークフローのデバッグを示します。 デバッガーがワークフロー関数にステップ インすると、デバッガー プロンプトは "[WFDBG]" に変わります。

PS C:> Set-PSBreakpoint -Script C:\TestWFDemo1.ps1 -Line 8

ID Script           Line Command    Variable     Action
-- ------           ---- -------    --------     ------
0 TestWFDemo1.ps1   8

PS C:> C:\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:"
# +!INCLUDE[]~~~~~

[WFDBG:localhost]: 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"

[WFDBG:localhost]: PS C:>> $MyOutput
Hello
[WFDBG:localhost]: PS C:>> stepOver
Now writing output:
At C:\TestWFDemo1.ps1:9 char:5
+     Write-Output -Input $MyOutput
# +!INCLUDE[]~

[WFDBG:localhost]: PS C:>> list

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"
# 19:


[WFDBG:localhost]: PS C:>> stepOver
Hello
At C:\TestWFDemo1.ps1:11 char:5
+     Write-Output -InputObject "Get PowerShell process:"
# +!INCLUDE[]~~~~~~~~~

[WFDBG:localhost]: PS C:>> stepOut
Get PowerShell process:

Handles  NPM(K)    PM(K)    WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----    ----- -----   ------     -- -----------
    433      35   106688   128392   726     2.67   7124 powershell
    499      44   134244   172096   787     2.79   7452 powershell

Workflow function complete.

関数のデバッグ

Begin、Process、および End セクションを持つ関数にブレークポイントを設定すると、デバッガーは各セクションの最初の行で中断します。

例えば次が挙げられます。

function test-cmdlet {
    begin {
        write-output "Begin"
    }
    process {
        write-output "Process"
    }
    end {
        write-output "End"
    }
}

C:\PS> Set-PSBreakpoint -command test-cmdlet

C:\PS> test-cmdlet

Begin
Entering debug mode. Use h or ? for help.

Hit Command breakpoint on 'prompt:test-cmdlet'

test-cmdlet

[DBG]: C:\PS> c
Process
Entering debug mode. Use h or ? for help.

Hit Command breakpoint on 'prompt:test-cmdlet'

test-cmdlet

[DBG]: C:\PS> c
End
Entering debug mode. Use h or ? for help.

Hit Command breakpoint on 'prompt:test-cmdlet'

test-cmdlet

# [DBG]: C:\PS>

リモートスクリプトのデバッグ

PowerShell 5.0 以降では、コンソールまたは Windows PowerShell ISE のリモート セッションで PowerShell デバッガーを実行できます。 Enter-PSSession 機能が更新され、リモート コンピュータで実行されていて、現在スクリプトを実行している切断されたセッションに再接続して参加できるようになりました。 実行中のスクリプトがブレークポイントにヒットすると、クライアント セッションによってデバッガーが自動的に開始されます。

次に示すのは、スクリプトの 6、11、22、25 行目にブレークポイントを設定して、これがどのように機能するかを示しています。 この例では、デバッガーが起動すると、セッションが実行されているコンピューターの名前と、デバッグ モードであることを知らせる DBG プロンプトの 2 つの識別プロンプトがあることに注意してください。

Enter-Pssession -Cn localhost
[localhost]: PS C:\psscripts> Set-PSBreakpoint .\ttest19.ps1 6,11,22,25

ID Script          Line     Command          Variable          Action
-- ------          ----     -------          --------          ------
0 ttest19.ps1          6
1 ttest19.ps1          11
2 ttest19.ps1          22
3 ttest19.ps1          25

[localhost]: PS C:\psscripts> .\ttest19.ps1
Hit Line breakpoint on 'C:\psscripts\ttest19.ps1:11'

At C:\psscripts\ttest19.ps1:11 char:1
+ $winRMName = "WinRM"
# + ~

[localhost]: [DBG]: PS C:\psscripts>> list

6:      1..5 | foreach { sleep 1; Write-Output "hello2day $_" }
7:  }
# 8:

9:  $count = 10
10:  $psName = "PowerShell"
11:* $winRMName = "WinRM"
12:  $myVar = 102
# 13:

14:  for ($i=0; $i -lt $count; $i++)
15:  {
16:      sleep 1
17:      Write-Output "Loop iteration is: $i"
18:      Write-Output "MyVar is $myVar"
# 19:

20:      hello2day
# 21:


[localhost]: [DBG]: PS C:\psscripts>> stepover
At C:\psscripts\ttest19.ps1:12 char:1
+ $myVar = 102
# + ~

[localhost]: [DBG]: PS C:\psscripts>> quit
[localhost]: PS C:\psscripts> Exit-PSSession
PS C:\psscripts>

例示

このテスト・スクリプトは、オペレーティング・システムのバージョンを検出し、システムに適したメッセージを表示します。 これには、関数、関数呼び出し、変数が含まれます。

次のコマンドは、テスト スクリプト ファイルの内容を表示します。

PS C:\PS-test>  Get-Content test.ps1

function psversion {
  "PowerShell " + $PSVersionTable.PSVersion
  if ($PSVersionTable.PSVersion.Major -lt 6) {
    "Upgrade to PowerShell 6.0!"
  }
  else {
    "Have you run a background job today (start-job)?"
  }
}

$scriptName = $MyInvocation.MyCommand.Path
psversion
"Done $scriptName."

開始するには、行、コマンド、変数、関数など、スクリプト内の関心のある場所にブレークポイントを設定します。

まず、現在のディレクトリ内の Test.ps1 スクリプトの最初の行に行ブレークポイントを作成します。

PS C:\ps-test> Set-PSBreakpoint -line 1 -script test.ps1

このコマンドは次のように省略できます。

PS C:\ps-test> spb 1 -s test.ps1

このコマンドは、行ブレークポイント オブジェクト (System.Management.Automation.LineBreakpoint) を返します。

Column     : 0
Line       : 1
Action     :
Enabled    : True
HitCount   : 0
Id         : 0
Script     : C:\ps-test\test.ps1
ScriptName : C:\ps-test\test.ps1

次に、スクリプトを開始します。

PS C:\ps-test> .\test.ps1

スクリプトが最初のブレークポイントに到達すると、ブレークポイント メッセージはデバッガーがアクティブであることを示します。 ブレークポイントについて説明し、スクリプトの最初の行 (関数宣言) をプレビューします。 コマンド プロンプトも変更され、デバッガーに制御があることを示します。

プレビュー行には、プレビューされたコマンドのスクリプト名と行番号が含まれます。

Entering debug mode. Use h or ? for help.

Hit Line breakpoint on 'C:\ps-test\test.ps1:1'

test.ps1:1   function psversion {
# DBG>

Step コマンドを使用して、スクリプトの最初のステートメントを実行し、次のステートメントをプレビューします。 次のステートメントでは、$MyInvocation 自動変数を使用して、$scriptName 変数の値をスクリプト ファイルのパスとファイル名に設定します。

DBG> s
test.ps1:11  $scriptName = $MyInvocation.MyCommand.Path

この時点では、 $scriptName 変数は入力されていませんが、変数の値を表示することで変数の値を確認できます。 この場合、値は $null です。

DBG> $scriptname
# DBG>

別の Step コマンドを使用して、現在のステートメントを実行し、スクリプト内の次のステートメントをプレビューします。 次のステートメントでは、 PsVersion 関数を呼び出します。

DBG> s
test.ps1:12  psversion

この時点で、$scriptName 変数が設定されますが、その値を表示して変数の値を確認します。 この場合、値はスクリプト パスに設定されます。

DBG> $scriptName
C:\ps-test\test.ps1

別の Step コマンドを使用して関数呼び出しを実行します。 Enter キーを押すか、ステップに「s」と入力します。

DBG> s
test.ps1:2       "PowerShell " + $PSVersionTable.PSVersion

デバッグ メッセージには、関数内のステートメントのプレビューが含まれています。 このステートメントを実行し、関数内の次のステートメントをプレビューするには、Step コマンドを使用できます。 ただし、この場合は、StepOut コマンド (o) を使用します。 関数の実行が完了し (ブレークポイントに達しない限り)、スクリプト内の次のステートメントにステップ実行されます。

DBG> o
Windows PowerShell 2.0
Have you run a background job today (start-job)?
test.ps1:13  "Done $scriptName"

スクリプトの最後のステートメントを使用しているため、ステップ、ステップアウト、および続行コマンドの効果は同じです。 この場合は、StepOut (o) を使用します。

Done C:\ps-test\test.ps1
PS C:\ps-test>

StepOut コマンドは、最後のコマンドを実行します。 標準のコマンド プロンプトは、デバッガーが終了し、コマンド プロセッサに制御を返したことを示します。

次に、デバッガーをもう一度実行します。 最初に、現在のブレークポイントを削除するには、Get-PSBreakpoint コマンドレットと Remove-PSBreakpoint コマンドレットを使用します。 (ブレークポイントを再利用する可能性があると思われる場合は、Disable-PSBreakpointの代わりに Remove-PSBreakpoint コマンドレットを使用してください)。

PS C:\ps-test> Get-PSBreakpoint| Remove-PSBreakpoint

このコマンドは次のように省略できます。

PS C:\ps-test> gbp | rbp

または、次の関数などの関数を記述してコマンドを実行します。

function delbr { gbp | rbp }

次に、$scriptname 変数にブレークポイントを作成します。

PS C:\ps-test> Set-PSBreakpoint -variable scriptname -script test.ps1

コマンドは次のように省略できます。

PS C:\ps-test> sbp -v scriptname -s test.ps1

次に、スクリプトを開始します。 スクリプトは変数ブレークポイントに到達します。 既定のモードは Write なので、変数の値を変更するステートメントの直前に実行が停止します。

PS C:\ps-test> .\test.ps1
Hit Variable breakpoint on 'C:\ps-test\test.ps1:$scriptName'
(Write access)

test.ps1:11  $scriptName = $MyInvocation.MyCommand.Path
# DBG>

$scriptNameされている $null 変数の現在の値を表示します。

DBG> $scriptName
# DBG>

ステップコマンド (s) を使用して、変数を設定するステートメントを実行します。 次に、$scriptName 変数の新しい値を表示します。

DBG> $scriptName
C:\ps-test\test.ps1
```powershell

Use a Step command (s) to preview the next statement in the script.

```powershell
DBG> s
test.ps1:12  psversion

次のステートメントは、 PsVersion 関数の呼び出しです。 関数をスキップして実行するには、StepOver コマンド (v) を使用します。 StepOverを使用するときにすでに機能に入っている場合、効果はありません。 関数呼び出しは表示されますが、実行されません。

DBG> v
Windows PowerShell 2.0
Have you run a background job today (start-job)?
test.ps1:13  "Done $scriptName"

StepOver コマンドは関数を実行し、スクリプト内の次のステートメントをプレビューし、最終行を出力します。

Stop コマンド (t) を使用してデバッガーを終了します。 コマンド プロンプトが標準のコマンド プロンプトに戻ります。

C:\ps-test>

ブレークポイントを削除するには、Get-PSBreakpoint コマンドレットと Remove-PSBreakpoint コマンドレットを使用します。

PS C:\ps-test> Get-PSBreakpoint| Remove-PSBreakpoint

PsVersion 関数に新しいコマンド ブレークポイントを作成します。

PS C:\ps-test> Set-PSBreakpoint -command psversion -script test.ps1

このコマンドを省略すると、次のことができます。

PS C:\ps-test> sbp -c psversion -s test.ps1

次に、スクリプトを実行します。

PS C:\ps-test> .\test.ps1
Hit Command breakpoint on 'C:\ps-test\test.ps1:psversion'

test.ps1:12  psversion
# DBG>

スクリプトは、関数呼び出しでブレークポイントに到達します。 この時点では、関数はまだ呼び出されていません。 これにより、Set-PSBreakpoint の Action パラメーターを使用してブレークポイントの実行条件を設定したり、ログの開始や診断スクリプトやセキュリティ スクリプトの呼び出しなどの準備タスクや診断タスクを実行したりできます。

アクションを設定するには、Continue コマンド (c) を使用してスクリプトを終了し、Remove-PSBreakpoint コマンドを使用して現在のブレークポイントを削除します。 (ブレークポイントは読み取り専用であるため、現在のブレークポイントにアクションを追加することはできません。

DBG> c
Windows PowerShell 2.0
Have you run a background job today (start-job)?
Done C:\ps-test\test.ps1

PS C:\ps-test> Get-PSBreakpoint| Remove-PSBreakpoint
PS C:\ps-test>

次に、アクションを含む新しいコマンド ブレークポイントを作成します。 次のコマンドは、関数の呼び出し時に $scriptName 変数の値をログに記録するアクションを使用して、コマンド ブレークポイントを設定します。 アクションで Break キーワードが使用されていないため、実行は停止しません。 (バックティック (') は行連結文字です。

PS C:\ps-test> Set-PSBreakpoint -command psversion -script test.ps1  `
-action { add-content "The value of `$scriptName is $scriptName." `
-path action.log}

ブレークポイントの条件を設定するアクションを追加することもできます。 次のコマンドでは、実行ポリシーが RemoteSigned (スクリプトの実行を許可する最も制限の厳しいポリシー) に設定されている場合にのみ、コマンド ブレークポイントが実行されます。 (バックティック (') は継続文字です。

PS C:\ps-test> Set-PSBreakpoint -script test.ps1 -command psversion `
-action { if ((Get-ExecutionPolicy) -eq "RemoteSigned") { break }}

アクションの Break キーワードは、デバッガーにブレークポイントを実行するように指示します。 Continue キーワードを使用して、中断せずにデバッガを実行するように指示することもできます。 デフォルトのキーワードは Continue であるため、実行を停止するには Break を指定する必要があります。

次に、スクリプトを実行します。

PS C:\ps-test> .\test.ps1
Hit Command breakpoint on 'C:\ps-test\test.ps1:psversion'

test.ps1:12  psversion

実行ポリシーは RemoteSigned に設定されているため、関数呼び出しで実行が停止します。

この時点で、呼び出し履歴を確認できます。 Get-PsCallStack コマンドレットまたは Get-PsCallStack デバッガー コマンド (k) を使用します。 次のコマンドは、現在の呼び出し履歴を取得します。

DBG> k
2: prompt
1: .\test.ps1: $args=[]
0: prompt: $args=[]

この例では、PowerShell デバッガーを使用するさまざまな方法のほんの一部を示します。

デバッガー コマンドレットの詳細については、次のコマンドを入力します。

help <cmdlet-name> -full

たとえば、次のように入力します。

help Set-PSBreakpoint -full

PowerShell のその他のデバッグ機能

PowerShell デバッガーに加えて、PowerShell には、スクリプトと関数のデバッグに使用できる他のいくつかの機能が含まれています。

  • Windows PowerShell ISE には、対話型のグラフィカル デバッガーが含まれています。 詳細については、Windows PowerShell ISE を起動して F1 キーを押します。

  • Set-PSDebug コマンドレットには、ステップ実行やトレースなど、非常に基本的なスクリプト デバッグ機能が用意されています。

  • Set-StrictMode コマンドレットを使用して、初期化されていない変数への参照、オブジェクトの存在しないプロパティへの参照、および無効な関数構文への参照を検出します。

  • 変数の値を表示するステートメント、コマンド ラインから入力を読み取るステートメント、現在の命令を報告するステートメントなど、診断ステートメントをスクリプトに追加します。 Write-Host、Write-Debug、Write-Warning、Write-Verboseなど、このタスクの書き込み動詞を含むコマンドレットを使用します。

関連項目

  • Last updated on