Disable-PSBreakpoint

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

現在のコンソール内のブレークポイントを無効にします。

構文

Disable-PSBreakpoint
       [-PassThru]
       [-Breakpoint] <Breakpoint[]>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-PSBreakpoint
       [-PassThru]
       [-Id] <Int32[]>
       [-Runspace <Runspace>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

説明

このコマンドレットは Disable-PSBreakpoint ブレークポイントを無効にし、スクリプトの実行時にヒットしないことを保証します。 これを使用してすべてのブレークポイントを無効にするか、ブレークポイント オブジェクト ID またはブレークポイント ID を送信してブレークポイントを指定することができます。

技術的には、このコマンドレットを使用して、ブレークポイントのオブジェクトの Enabled プロパティの値を False に変更します。 ブレークポイントを再度有効にするには、コマンドレットを Enable-PSBreakpoint 使用します。 コマンドレットを使用してブレークポイントを作成すると、既定でブレークポイントが Set-PSBreakpoint 有効になります。

ブレークポイントは、スクリプト内の指示を調べることができるように、実行を一時的に停止するスクリプト内のポイントです。 Disable-PSBreakpoint は、PowerShell スクリプトのデバッグ用に設計されたいくつかのコマンドレットの 1 つです。 PowerShell デバッガーの詳細については、「about_Debuggers」を参照してください。

例

例 1: ブレークポイントを設定して無効にする

これらのコマンドは、新しく作成したブレークポイントを無効にします。

$B = Set-PSBreakpoint -Script "sample.ps1" -Variable "name"
$B | Disable-PSBreakpoint

このコマンドレットはSet-PSBreakpoint、スクリプト内の変数にブレークポイントを$NameSample.ps1作成し、ブレークポイント オブジェクトを変数に$B保存します。 コマンドレットは Disable-PSBreakpoint 、新しいブレークポイントを無効にします。 パイプライン演算子 (|) を使用して、ブレークポイント オブジェクト $B をコマンドレットに Disable-PSBreakpoint 送信します。

このコマンドの結果として、ブレークポイント オブジェクトの Enabled プロパティの値は False になります。$B

例 2: ブレークポイントを無効にする

このコマンドは、ブレークポイント ID が 0 のブレークポイントを無効にします。

Disable-PSBreakpoint -Id 0

例 3: 無効なブレークポイントを作成する

このコマンドは、有効に設定するまで無効である新しいブレークポイントを作成します。

Disable-PSBreakpoint -Breakpoint ($B = Set-PSBreakpoint -Script "sample.ps1" -Line 5)

コマンドレットを Disable-PSBreakpoint 使用してブレークポイントを無効にします。 Breakpoint パラメーターの値は、Set-PSBreakpoint新しいブレークポイントを設定し、ブレークポイント オブジェクトを生成し、そのオブジェクトを変数に保存する$Bコマンドです。

オブジェクトを値として受け取るコマンドレットのパラメーターは、オブジェクトを含む変数や、オブジェクトを取得または生成するコマンドを受け取ることができます。 この場合、ブレークポイント オブジェクトを生成するためSet-PSBreakpoint、ブレークポイント パラメーターの値として使用できます。

例 4: 現在のコンソールのすべてのブレークポイントを無効にする

このコマンドは、現在のコンソールのすべてのブレークポイントを無効にします。

`Get-PSBreakpoint` | Disable-PSBreakpoint

例 5: 実行空間でブレークポイントを無効にする

この例では、ジョブが開始され、Set-PSBreakPoint の実行時に中断するようにブレークポイントが設定されます。 実行空間は変数に格納され、Runspace パラメーターを使用して Get-PSBreakPoint コマンドに渡されます。 出力 Get-PSBreakPoint はパイプ処理され Disable-PSBreakpoint 、実行空間のブレークポイントが無効になります。

Start-Job -ScriptBlock {
    Set-PSBreakpoint -Command Start-Sleep
    Start-Sleep -Seconds 10
}

$runspace = Get-Runspace -Id 1

Get-PSBreakPoint -Runspace $runspace | Disable-Breakpoint -Runspace $runspace

パラメーター

-Breakpoint

無効にするブレークポイントを指定します。 ブレークポイント オブジェクトを含む変数、またはブレークポイント オブジェクトを取得するコマンド (コマンドなど) を Get-PSBreakpoint 入力します。 ブレークポイント オブジェクトをコマンドレットに Disable-PSBreakpoint パイプすることもできます。

Type:Breakpoint[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

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

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

-Id

指定したブレークポイント ID を持つブレークポイントを無効にします。 ID または ID が含まれる変数を入力します ID をパイプ先に Disable-PSBreakpointすることはできません。

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

-PassThru

有効になっているブレークポイントを表すオブジェクトが返されます。 既定では、このコマンドレットによる出力はありません。

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

-Runspace

指定した実行空間内の ブレークポイントを操作できるように、Runspace オブジェクトの ID を指定します。

このパラメーターは PowerShell 7.2 で追加されました。

Type:Runspace
Aliases:RunspaceId
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

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

入力

Breakpoint

ブレークポイント オブジェクトをこのコマンドレットにパイプできます。

出力

None

既定では、このコマンドレットは出力を返しません。

Breakpoint

PassThru パラメーターを使用すると、このコマンドレットは無効なブレークポイントを表すブレークポイント オブジェクトを返します。

メモ

PowerShell には、次のエイリアスが Disable-PSBreakpoint含まれています。

  • すべてのプラットフォーム:
    • dbp