Поделиться через

Wait-Debugger

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Останавливает скрипт в отладчике перед выполнением следующей инструкции в скрипте.

Синтаксис

Wait-Debugger []

Описание

Останавливает подсистему выполнения скриптов PowerShell в точке сразу после командлета Wait-Debugger и ожидает подключения отладчика.

Внимание

Убедитесь, что вы удалите Wait-Debugger строки после завершения. Выполняющийся скрипт, как представляется, зависает, когда он остановился на Wait-Debugger.

Дополнительные сведения об отладке в PowerShell см. в about_Debuggers.

Примеры

Пример 1. Вставка точки останова для отладки

Файл dbgtest.ps1 содержит функцию Test-Condition. Команда Wait-Debugger была вставлена в функцию, чтобы остановить выполнение скрипта на этом этапе. При запуске функции скрипт останавливается в Wait-Debugger строке и вводит отладчик командной строки. В команде l перечислены строки скрипта, а для проверки состояния скрипта можно использовать другие команды отладчика.

function Test-Condition {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory)]
        [string]$Name,
        [string]$Message = "Hello, $Name!"
    )

    if ($Name -eq $env:USERNAME) {
        Write-Output "$Message"
    } else {
        # Remove after debugging
        Wait-Debugger

        Write-Output "$Name is not the current user."
    }
}

PS D:\> Test-Condition Fred
Entering debug mode. Use h or ? for help.

At D:\temp\test\dbgtest.ps1:13 char:9
+         Wait-Debugger
+         ~~~~~~~~~~~~~
[DBG]: PS D:\>> l

    8:
    9:      if ($Name -eq $env:USERNAME) {
   10:          Write-Output "$Message"
   11:      } else {
   12:          # Remove after debugging
   13:*         Wait-Debugger
   14:
   15:          Write-Output "$Name is not the current user."
   16:      }
   17:  }

[DBG]: PS D:\>> $env:USERNAME
User01
[DBG]: PS D:\>> exit
PS D:\>

Обратите внимание, что выходные данные показывают l , что выполнение скрипта остановлено в строке Wait-Debugger 13.

Пример 2. Вставка точки останова для отладки ресурса DSC

В этом примере Wait-Debugger команда была вставлена в CopyFile метод ресурса DSC. Это похоже на использование Enable-RunspaceDebug -BreakAll в ресурсе DSC, но разрывается в определенной точке сценария.

[DscResource()]
class FileResource
{
    [DscProperty(Key)]
    [string] $Path

    [DscProperty(Mandatory)]
    [Ensure] $Ensure

    [DscProperty(Mandatory)]
    [string] $SourcePath

    [DscProperty(NotConfigurable)]
    [Nullable[datetime]] $CreationTime


    [void] Set() {
        $fileExists = $this.TestFilePath($this.Path)
        if ($this.ensure -eq [Ensure]::Present) {
            if (! $fileExists) {
               $this.CopyFile()
            }
        } else {
            if ($fileExists) {
                Write-Verbose -Message "Deleting the file $($this.Path)"
                Remove-Item -LiteralPath $this.Path -Force
            }
        }
    }

    [bool] Test() {
        $present = Test-Path -LiteralPath $this.Path
        if ($this.Ensure -eq [Ensure]::Present) {
            return $present
        } else {
            return (! $present)
        }
    }

    [FileResource] Get() {
        $present = Test-Path -Path $this.Path
        if ($present) {
            $file = Get-ChildItem -LiteralPath $this.Path
            $this.CreationTime = $file.CreationTime
            $this.Ensure = [Ensure]::Present
        } else {
            $this.CreationTime = $null
            $this.Ensure = [Ensure]::Absent
        }
        return $this
    }

    [void] CopyFile() {
        # Testing only - Remove before deployment!
        Wait-Debugger

        if (! (Test-Path -LiteralPath $this.SourcePath)) {
            throw "SourcePath $($this.SourcePath) is not found."
        }
        if (Test-Path -LiteralPath $this.Path -PathType Container) {
            throw "Path $($this.Path) is a directory path"
        }
        Write-Verbose "Copying $($this.SourcePath) to $($this.Path)"
        Copy-Item -LiteralPath $this.SourcePath -Destination $this.Path -Force
    }
}

Входные данные

None

Невозможно передать объекты в этот командлет.

Выходные данные

None

Этот командлет не возвращает выходные данные.