Точки останова и пошаговые сценарии отладки в power shell

Фоновое выполнение команд

Определенные задачи могут требовать значительного времени на выполнение. Примеры таких задач включают установку и обновление программного обеспечения или поиск файлов в обширной директории. Важно помнить, что во время выполнения одной команды в PowerShell нельзя вводить другие команды.

Рассмотрим пример: предположим, нужно найти файл powershell.exe на всем диске C. Для этой цели  воспользуемся командлетом Get-ChildItem с параметром -Recurse. Это позволит ему искать файл не только в текущем каталоге, но и во всех его подкаталогах.

Следует учитывать, что PowerShell может столкнуться с папками, к которым у него нет доступа. Чтобы обойти возможные ошибки, добавим параметр -ErrorAction SilentlyContinue. Это означает, что в случае ошибки команда не будет генерировать уведомления, а просто продолжит выполнение.

Таким образом, данная ситуация выглядит следующим образом:

Get-ChildItem -Path C:\ -Name powershell.exe -Recurse -ErrorAction SilentlyContinue

Очевидно, что во время выполнения задачи, командная строка становится недоступной. Для принудительного прерывания выполнения задачи можно воспользоваться сочетанием клавиш Ctrl + C. Важно убедиться, что при этом ничего не выделено, чтобы избежать возможного восприятия компьютером как команды «Копировать».

Start-Job {Get-ChildItem -Path C:\ -Name powershell.exe -Recurse -ErrorAction SilentlyContinue}

Параллельно возможно выполнение любого числа фоновых задач. В дополнение к командлету Start-Job, предназначенному для управления фоновыми задачами, существуют и другие командлеты:

• Get-Job предоставляет отчет о состоянии фоновых задач.
• Wait-Job блокирует консоль до завершения фоновой задачи.
• Stop-Job прекращает выполнение фоновой задачи.
• Receive-Job выводит результаты выполнения фоновой задачи и очищает их из памяти. Для сохранения результатов в памяти используйте параметр -Keep.

Опции Wait-Job, Stop-Job и Receive-Job требуют указания имени Name или идентификатора Id конкретной задачи или задач (в случае нескольких). Это можно сделать непосредственно или в связке с командлетом Get-Job.

Get-Job Job1

Команды (командлеты) PowerShell

В языке программы PowerShell команды носят название командлеты (от английского «cmdlet»). Все они формируются с использованием шаблона «Глагол-Существительное», или «Действие-Объект». Например, Get-Services и Start-Process. Благодаря такой структуре, можно легко понять предназначение команды, даже если вы с ней ещё не работали ранее.

Синтаксис командлетов

После имени самого командлета следует указание параметров и их значений. Между всеми частями команды следует проставлять пробелы. Вот пример синтаксиса командлета, который позволяет перейти в директорию C:\:

Set-Location -LiteralPath C:\ -PassThru

Разберем его на составные части:

• Set-Location — буквально «вызвать команду». Этот командлет позволяет выполнять указанный блок сценария.
• -LiteralPath C:\ — здесь передаем блок сценария, в котором используется команда Set-Location для перехода в каталог C:\.
• -PassThru — по умолчанию командлет Invoke-Command не возвращает результат выполнения. Этот параметр указывает на необходимость вывода информации о местоположении, в которое был выполнен переход с помощью команды Set-Location.

Важно отметить, что регистр букв в командах PowerShell не имеет значения. Таким образом, данную команду можно записать в виде заглавных букв, строчных букв или даже смешанного регистра, и она все равно будет выполняться:

sEt-loCATion -PATH c:\ -passthru

Когда в одной строке объединены несколько команд, они разделяются точкой с запятой ;.

Иногда команда может быть слишком длинной. Для разделения на несколько строк можно использовать символ обратного апострофа ` в месте переноса. Новую строку можно создать, нажав Shift + Enter (для переноса строки ниже текущей) или Ctrl + Enter (для переноса строки выше текущей).

Разделим предыдущую команду:

Set-Location `
-LiteralPath C:\ `
-PassThru

Алиасы

В процессе работы с терминалом иногда может быть неудобно постоянно вводить полные названия командлетов. Именно поэтому у наиболее часто используемых командлетов существуют псевдонимы (алиасы) — их сокращенные варианты.

Чтобы получить список доступных алиасов, вы можете воспользоваться командой Get-Alias. Кроме того, данной команде также доступен псевдоним gal.

Чтобы получить список алиасов для конкретного командлета, вы можете использовать параметр -Definition. Пример:

Get-Alias -Definition Set-Location

Если вам нужно узнать полное название командлета по его алиасу, используйте параметр -Name. Этот параметр необязателен, так как он является аргументом по умолчанию.

# Оба следующих варианта эквивалентны:
Get-Alias -Name clear
Get-Alias clear

Особенности обработки путей к каталогам

Для многих командлетов необходимо предоставить путь к файлу или каталогу. Это делается с использованием строки, например: C:\Windows\System32.

Однако, если в пути встречается пробел или другой специальный символ, PowerShell будет рассматривать его как разделитель. Например:

# Следующая команда не будет выполнена корректно
Set-Location C:\Program Files

PowerShell «воспринимает» пробел и интерпретирует его так, будто путь к папке закончился на слове Program, а files — это уже значение другого параметра.

Чтобы избежать подобных ситуаций, существует два метода:

• Экранировать символы с помощью обратного апострофа `: C:\Program` Files. Однако это может быть неудобным, если путь длинный.
• Поместить весь путь в одинарные или двойные кавычки: 'C:\Program Files' или "C:\Program Files" (желательнее использовать одинарные кавычки).

Кроме того, в PowerShell существуют сокращения для быстрого доступа к ближайшим директориям:

• Точка . указывает на текущий каталог. Например, Get-ChildItem . позволяет просмотреть содержимое текущего местоположения.
• Две точки .. указывают на родительский каталог. Например, Set-Location .. позволяет перейти к родительскому каталогу. Это может быть полезно, если вы находитесь в глубоко вложенной директории.

Большинство командлетов имеют параметры -Path и -LiteralPath, позволяющие указать путь к файлу или папке. Разница между ними заключается в том, что в -Path можно включать переменные, в то время как —LiteralPath интерпретирует символы буквально, даже если они содержат имя переменной.

Get-Help: как изучать новые командлеты

Для получения подробной информации о конкретном командлете воспользуйтесь командой Get-Help Название-Командлета. Пример:

Get-Help Get-Childitem

У команды Get-Help имеется несколько полезных параметров:

• -Detailed предоставляет более подробную справку по командлету.
• -Full предоставляет полную справку.
• -Examples демонстрирует примеры использования командлета.
• -Online перенаправляет пользователя на веб-страницу с соответствующей документацией.

Работа в PowerShell ISE

Командная оболочка PowerShell представляет собой удобный инструмент для выполнения малых, кратких однострочных задач. Однако для создания и сохранения более сложных сценариев существует интегрированная среда разработки скриптов PowerShell ISE.

PowerShell ISE представляет собой инструмент, состоящий из трех основных панелей:

• Область скриптов в верхней части экрана, предназначенная для написания сценариев.
• Консольная область в нижней части экрана, которая функционирует как обычный терминал, позволяя вводить команды в интерактивном режиме.
• Панель команд в правой части экрана, предоставляющая полное руководство по командам PowerShell. В ней также есть конструктор, который помогает задать значения нужных параметров.

Комментарии в коде

Вот пример PowerShell скрипта с комментариями:

# Это комментарий в одну строку, начинается с символа '#' и продолжается до конца строки.
# Пример переменной
$имя = "John"
$возраст = 30
# Вывод информации
Write-Host "Привет, $имя! Тебе $возраст лет."
# Это многострочный комментарий, который начинается с '<#' и заканчивается '#>'.
<#
Этот блок комментария может быть многострочным и располагаться
на нескольких строках, чтобы объяснить более сложные участки кода.
#>
# Функция для сложения двух чисел
function Сложить-Числа { param( [int]$число1, [int]$число2 ) $результат = $число1 + $число2 return $результат
}
# Вызов функции и вывод результата
$результатСложения = Сложить-Числа -число1 5 -число2 7
Write-Host "Результат сложения: $результатСложения"

Хорошая практика — комментировать код таким образом, чтобы другие разработчики (или вы в будущем) могли легко понять, как работает код и какие цели преследовались при его написании.

Советы по написанию хорошего кода:

• Применяйте нотацию PascalCase для названий командлетов, функций, параметров, свойств, методов, переменных и классов. Разработчики Powershell выпустили для этого гайд. Не рекомендуется: get-service, Get-service, GET-SERVICE. Рекомендуется: Get-Service.
• Используйте полные названия командлетов. Алиасы удобны для интерактивного режима, но в скриптах они могут затруднить понимание. Не рекомендуется: dir, gci, ls. Рекомендуется: Get-ChildItem.
• Применяйте стиль One True Brace для форматирования вложенных блоков кода. Если вы используете фигурные скобки, внутренний код отделяется табуляцией (четыре пробела), а фигурные скобки размещаются следующим образом:

if ($var1 -eq $var2) {
    # Код внутри условия
} else {
    # Код внутри else
    # Еще код внутри else
}

Исключение: когда код внутри фигурных скобок небольшой, его можно записать в одну строку:

Get-ChildItem | Where-Object { $_.Length -gt 10mb }

Запуск скриптов

В PowerShell ISE имеется возможность выполнять код как целиком, так и частично, а также предоставляются инструменты для отладки. Скрипты сохраняются в файлах с расширением .ps1. Однако запустить скрипт, просто дважды щелкнув по нему, не получится. Вместо этого вы можете нажать правую кнопку мыши и выбрать опцию Выполнить с помощью PowerShell.

Также существует возможность запуска скрипта из оболочки. Например, предположим, у вас есть файл скрипта test_script.ps1 в каталоге C:\Scripts. Вы можете выполнить его двумя способами:

1. Используя команду PowerShell -File C:\Scripts\test_script.ps1 из любого места. Это позволяет запустить скрипт, указав полный путь к файлу.
2. Используя команду .\test_script.ps1, если вы находитесь в каталоге C:\Scripts. Это запустит скрипт, находясь в том же каталоге, что и файл скрипта.

Такие методы позволяют управлять выполнением PowerShell скриптов из разных мест и с разных уровней оболочки.

Политика выполнения. Как разрешить выполнения скриптов

По умолчанию запрещено выполнение файлов с PowerShell-скриптами, и это сделано с целью обеспечения безопасности. Вы можете узнать текущую политику выполнения с помощью командлета Get-ExecutionPolicy. Вот какие варианты политики выполнения могут быть доступны:

• Restricted (Установлена по умолчанию) — запрещено выполнение любых скриптов. Это означает, что нельзя будет запустить ни один скрипт.
• AllSigned — разрешено выполнение только тех скриптов, которые были подписаны доверенным разработчиком. Это обеспечивает повышенный уровень безопасности, так как только подписанные и проверенные скрипты могут быть выполнены.
• RemoteSigned — разрешено выполнение подписанных доверенным разработчиком скриптов, а также собственных скриптов. Это предоставляет баланс между безопасностью и удобством, позволяя запускать свои скрипты.
• Unrestricted — разрешено выполнение любых скриптов без каких-либо ограничений. Это предоставляет наивысший уровень гибкости, но может повысить риск безопасности.

Чтобы ваши файлы с расширением .ps1 запускались, вам следует изменить политику выполнения на RemoteSigned. Для этого выполните следующие шаги:

• Откройте PowerShell от имени администратора. Для этого щелкните правой кнопкой мыши по значку PowerShell на панели задач или в меню «Пуск» и выберите «Запуск от имени администратора».
• В открывшемся окне PowerShell введите следующую команду и нажмите Enter:

Set-ExecutionPolicy RemoteSigned

• Подтвердите изменение политики выполнения, нажав клавишу Y (Yes).

Теперь вы сможете запускать свои файлы .ps1 без ограничений. Однако, имейте в виду, что изменение политики выполнения может повлиять на безопасность системы, поэтому будьте осторожны и убедитесь, что вы запускаете только те скрипты, которые вы знаете и доверяете.

Условия

Условные операторы в PowerShell создаются с использованием ключевых слов if, elseif и else. В круглых скобках указывается само условие, а в фигурных скобках содержится код, который выполняется при выполнении условия. Например:

$Number = 123
if ($Number -gt 0) {
    Write-Host 'Число больше нуля'
} elseif ($Number -lt 0) {
    Write-Host 'Число меньше нуля'
} else {
    Write-Host 'Число равно нулю'
}
Результат выполнения кода: Число больше нуля

Кроме того, условия также можно задавать с помощью ключевого слова switch. Например:

$Day = 5
switch ($Day) {
    1 { Write-Host 'Понедельник' }
    2 { Write-Host 'Вторник' }
    3 { Write-Host 'Среда' }
    4 { Write-Host 'Четверг' }
    5 { Write-Host 'Пятница' }
    6 { Write-Host 'Суббота' }
    7 { Write-Host 'Воскресенье' }
}
Результат выполнения кода: Пятница

Как открыть PowerShell в Windows

Как правило, PowerShell уже установлен на вашем компьютере по умолчанию. Однако, если по какой-то причине его нет, вы можете воспользоваться инструкциями, предоставленными Microsoft. В дополнение, в официальной документации имеются подробные руководства по установке на macOS и Linux.

PowerShell является независимым от версии операционной системы инструментом и работает одинаково стабильно как на Windows 10, так и на Windows Server.

Существует два основных метода для запуска PowerShell или PowerShell ISE в системе Windows: через меню «Пуск» и с помощью приложения «Выполнить».

• Для того чтобы открыть PowerShell через меню «Пуск», пройдите к папке Windows PowerShell, откройте её и выберите необходимое приложение. В этой директории доступны как 32-разрядные версии (отмечены как x86 в скобках), так и 64-разрядные версии терминала и ISE.

• Чтобы запустить PowerShell через приложение «Выполнить», используйте комбинацию клавиш Win + R. Когда появится окно, введите powershell или powershell ise (в зависимости от того, какое приложение вам нужно) и нажмите кнопку ОК.

Объекты и конвейеры (пайплайны) в PowerShell

Когда вы работаете с командлетами в PowerShell, они возвращают не просто строки, а объекты — структуры данных, содержащие набор свойств и методов. 

То, что отображается в терминале после выполнения команды в виде строки, на самом деле является визуальным представлением объекта. Программа PowerShell отображает определенные свойства объектов в виде таблицы, но далеко не все свойства могут быть отображены таким образом.

Аналогично тому, как командлеты могут возвращать объекты, они также могут принимать и обрабатывать их. Вы можете создать команду, которая возвращает объект, передать этот объект другому командлету, получить объект из него и так далее — этот процесс и называется конвейерами или пайплайнами.

Пример работы конвейера в PowerShell

Команда Get-Process возвращает список запущенных процессов на компьютере. При передаче ей имени процесса (или шаблона, созданного с помощью регулярных выражений), команда выведет только соответствующие элементы списка.

Рассмотрим пример, где вызываем запущенный процесс PowerShell:

Get-Process powershell

Мы получаем объект и таблицу, отображающую некоторые его свойства. Чтобы узнать все свойства и методы, давайте передадим этот объект командлету Get-Member. Для этого используется конвейер:

Get-Process powershell | Get-Member

Команда Get-Member получает объект от команды Get-Process и выводит таблицу со всеми его свойствами и методами. Результат работы Get-Member также представляет собой объект (точнее, список объектов), который можно передать по конвейеру дальше.

Допустим, нужно вывести только те строки, в которых MemberType равно Property. Для этого используем команду Where-Object:

Get-Process powershell | Get-Member | Where-Object {$_.MemberType -eq 'Property'}

Команда Where-Object последовательно обходит каждый объект, полученный от команды Get-Member. Выражение в фигурных скобках — логическое:

• $_ ссылается на текущий объект (то есть на отдельную строку в таблице);
• .MemberType обращается к значению свойства MemberType в этом объекте;
• -eq выполняет сравнение между выражением слева и выражением справа от него;
• 'Property' представляет значение, которое ожидаем увидеть у свойства MemberType.

Более подробно о логических выражениях рассказано ниже.

Форматирование таблиц с помощью конвейеров

Командлет Format-Table в PowerShell предоставляет возможность настроить вывод таблицы в терминале: выбирать нужные свойства и методы, устанавливать ширину столбцов, группировать данные по нескольким таблицам и т. д.

Форматируем таблицу, полученную с помощью командлета Get-Member. Следует использовать следующий синтаксис:

Get-Process powershell | Get-Member | Format-Table -AutoSize -Wrap -GroupBy MemberType -Property Name, Definition

Разберем параметры командлета Format-Table:

• -AutoSize выравнивает ширину столбцов в соответствии с размерами их содержимого. Это позволяет оптимально использовать ширину экрана.
• -Wrap переносит содержимое ячейки на новую строку, если оно не помещается в текущих размерах экрана. По умолчанию, если текст не помещается, он обрезается.
• -GroupBy позволяет разделить одну таблицу на несколько, сгруппированных по значению определенного свойства. В данном случае, для каждого значения MemberType будет создана отдельная таблица.
• -Property определяет, какие свойства объекта будут отображены в таблице в качестве столбцов. В данном примере, мы указали свойства Name и Definition.

Эти параметры позволяют настраивать внешний вид таблицы, сделать вывод более читабельным и структурированным.

Сортировка таблиц с помощью конвейеров

Командлет Sort-Object в PowerShell позволяет сортировать список объектов (таблицу) по значениям их свойств (столбцов). Давайте отсортируем результат, полученный с помощью командлета Get-Member, по столбцу Name в алфавитном порядке. Для этого  воспользуемся параметром -Property, который действует аналогично параметру у командлета Format-Table:

Get-Process powershell | Get-Member | Sort-Object -Property Name

Командлет Sort-Object в PowerShell имеет также другие полезные параметры:

• -Descending сортирует объекты в порядке убывания. Например:

Get-Process powershell | Get-Member | Sort-Object -Property Name -Descending

• -Unique удаляет дубликаты и возвращает только уникальные объекты. Например:

Get-Process powershell | Get-Member | Sort-Object -Property Name -Unique

• Параметр -Top получает число N и отображает первые N объектов в таблице. Например:

Get-Process | Sort-Object -Property CPU -Top 10

• Параметр -Bottom получает число N и отображает последние N объектов в таблице. Например:

Get-Process | Sort-Object -Property Memory -Descending -Bottom 5

Эти параметры позволяют более гибко настраивать сортировку и отображение объектов в выводе.

Stepping Through a PowerShell Script

Now that we understand how to use breakpoints in PowerShell, I will introduce another useful debugging technique called “stepping.”

As noted above, line breakpoints allow you to pause the script execution at a specific line so that you can examine variable values. Stepping works similarly, but instead of pausing the code at a particular line, it pauses the code at every line of the script. That way, you can trace the script’s flow and inspect variable contents at any point in the execution process.

Before we look at how to step through a script, it’s important to note that there are four distinct tasks related to stepping.

The second task is called “Step Into.” When you choose to step into a script, PowerShell executes the current line of code and then stops at the next line. If the next line happens to be a function call, PowerShell will proceed to call the function and stop at its first line. You can engage the Step Into task by pressing F11. Alternatively, you can type S and press Enter in the PowerShell console.

The third task to know is called “Step Over.” Like the Step Into task, Step Over executes the current line of code and then stops at the next line. However, the key difference is that if the next line happens to call a function, Step Over will execute the entire function without stepping through it line by line. You can invoke the Step Over task by pressing F10 or typing V + Enter in the PowerShell console.

The fourth task is called Step Out. Stepping Out causes the current function to be stepped. If the function is nested, one additional level will also be stepped. To invoke Step Out, you can press Shift + F11 or type O + Enter in the PowerShell console.

In addition to the shortcut keys that I have described, PowerShell ISE’s debug menu provides stepping options, as well.

How to use stepping

Let’s look at how to step through a simple script. For this guide, I have created a basic “Hello World” script.

$A=”Hello”$B=”World”Write-Host $A $B

The script assigns the word “Hello” to a variable called $A and assigns the word “World” to a variable called $B. The script’s last line uses the Write-Host statement to display the two variables in a way that shows Hello World on the screen.

Before stepping through a script, the first thing to do is to save the script. Then, set a breakpoint on the first line of code in the main body of the script. If the script starts with a function, do not set the breakpoint on the function declaration line. Instead, move to the main body’s first line of code and set the breakpoint there. In Figure 3, you can see that a breakpoint has been set on the first line of code.

PowerShell Debug 2-1

The first line of code serves as a breakpoint.

Next, select the “Run / Continue” option from the Debug menu (or press F5). This will execute the first line of code. Because the first line contains a breakpoint, the script will immediately pause at that point.

In Figure 4, you can see that I have entered the commands $A and $B in the console. Both commands return null values because the first line of code has not been executed yet.

PowerShell Debug 2-2

PowerShell has hit the breakpoint at the beginning of the script, and no values have been assigned to the variables yet.

Now let’s go ahead and Step Into the code. Select the Step Into command from the Debug menu. This highlights line 2 of the script as though a breakpoint had been assigned. The console also updates to display an additional prompt line. If you look at Figure 5, you can see that I have entered $A and $B once again. This time, there is a value for $A (Hello), but $B does not have a value yet because it hasn’t been assigned.

PowerShell Debug 2-3

The first line of code has now been executed.

Let’s repeat the process by selecting the Step Into command from the Debug menu again. As before, the breakpoint will move, and the console will update. If I now enter $A and $B, both variables will have values associated with them because the first and second lines of code have been executed.

PowerShell Debug 2-4_0

The second line of code has been executed.

Selecting the Step Into command once more will cause the third line of code to execute. In this case, that means that the script will run to completion, and the words “Hello World” will be displayed in the console. Because the script has finished running, the debugger will automatically close, as shown by the console prompt in Figure 7.

PowerShell Debug 2-5

The script has finished running and the debugger is closed.

Additional PowerShell Resources

Массивы, хеш-таблицы, функции и классы

В PowerShell есть множество возможностей для создания сложных структур данных и алгоритмов. Вот краткое описание некоторых из них:

• Массивы (Arrays): позволяют хранить набор элементов одного типа. Элементы могут быть доступны по индексам. Создаются массивы с использованием квадратных скобок [ ].

$fruits = "Apple", "Banana", "Orange"
$fruits[0]  # Доступ к элементу массива по индексу

• Хеш-таблицы (Hash Tables): представляют собой пары ключ-значение, где ключи уникальны. Они полезны для хранения и быстрого доступа к данным по ключу.

$person = @{
    Name = "John"
    Age = 30
    City = "New York"
}
$person["Name"]  # Доступ к значению по ключу

• Пользовательские функции: Вы можете определить собственные функции для группировки кода и повторного использования. Их определение происходит с использованием ключевого слова function.

function Get-Sum {
    param($a, $b)
    return $a + $b
}
$result = Get-Sum 5 3

• Пользовательские классы: PowerShell также поддерживает создание пользовательских классов, что позволяет создавать более сложные объекты с различными свойствами и методами.

class Person {
    [string] $Name
    [int] $Age
    Person([string] $name, [int] $age) {
        $this.Name = $name
        $this.Age = $age
    }
    [string] GetInfo() {
        return "$($this.Name), $($this.Age) years old"
    }
}
$person = [Person]::new("Alice", 25)
$info = $person.GetInfo()

Циклы

В PowerShell существует несколько видов циклов:

• Цикл с предусловием while:

$counter = 0
while ($counter -lt 5) { Write-Host "Counter is $($counter)" $counter++
}

• Цикл с постусловием истинным do while:

$counter = 0
do { Write-Host "Counter is $($counter)" $counter++
} while ($counter -lt 5)

• Цикл с постусловием ложным do until:

$counter = 0
do { Write-Host "Counter is $($counter)" $counter++
} until ($counter -ge 5)

• Цикл с известным числом итераций for:

for ($i = 0; $i -lt 5; $i++) { Write-Host "Iteration is $i"
}

• Цикл с перебором элементов коллекции foreach:

$numbers = 1..5
foreach ($num in $numbers) { Write-Host "Number is $num"
}

Во всех случаях синтаксис похож на синтаксис условных операторов: в круглых скобках указывается условие или параметры, а в фигурных скобках — код, который выполняется внутри цикла.

Логические операторы

В PowerShell вы также можете выполнять арифметические операции над объектами и строками, сравнивать их друг с другом, используя логические операторы.

• + — сложение;
• - — вычитание;
• * — умножение;
• / — деление;
• % — деление по модулю;
• ( и ) — скобки для группировки операций.

Операторы сравнения оформляются так же, как параметры командлетов, и их названия произошли от английских выражений, указанных в скобках:

• -eq — равно (от «equal»);
• -ne — не равно (от «not equal»);
• -gt — больше (от «greater than»);
• -ge — больше либо равно (от «greater than or equal»);
• -lt — меньше (от «less than»);
• -le — меньше либо равно (от «less than or equal»).

Переменные

Для сохранения данных и обращения к ним в будущем в PowerShell используются переменные. Перед названием переменной ставится символ доллара $, и переменные могут содержать латинские буквы (как заглавные, так и строчные), цифры и символ нижнего подчеркивания.

Переменные в могут хранить данные различных типов, и значения в них можно изменять (перезаписывать).

Создадим переменную со строкой 2023 и преобразуем её в число. Для того чтобы узнать тип данных, воспользуемся методом .GetType():

$stringValue = "2023"
$intValue = [int]$stringValue
$intValue.GetType()

Для удаления переменной используется метод .Clear().

Переменные можно вставлять в строки, если строки оформлены двойными кавычками. В случае одинарных кавычек, PowerShell воспринимает символы в строке буквально. Давайте сравним два примера:

$number = 42
Write-Host "The number is $number"   # Вывод: The number is 42
Write-Host 'The number is $number'   # Вывод: The number is $number

В первом случае, используя двойные кавычки, значение переменной $number подставляется в строку. Во втором случае, с использованием одинарных кавычек, строка остается буквальной, и $number не интерпретируется как переменная.

Кроме пользовательских переменных, существуют и системные переменные. Например, $PSVersionTable содержит информацию о версии PowerShell.

Работа со строками в PowerShell

PowerShell — мощный инструмент для автоматизации задач на платформе Windows. Работа со строками играет важную роль при обработке текстовых данных. Вот некоторые ключевые аспекты:

1. Объединение строк: Чтобы объединить строки, используйте оператор + или метод .Concat(). Пример:

$firstString = "Привет, "
$secondString = "мир!"
$combinedString = $firstString + $secondString

2. Форматирование строк: Используйте оператор -f или метод .Format() для вставки значений в строку. Пример:

$name = "Alice"
$age = 30
$formattedString = "Привет, меня зовут {0} и мне {1} лет." -f $name, $age

3. Интерполяция строк: С помощью символа $ и фигурных скобок {} можно вставлять значения переменных в строки. Пример:

$city = "Москва"
$interpolatedString = "Я живу в городе $($city)."

4. Разделение строк: Метод .Split() используется для разделения строки на подстроки. Пример:

$text = "яблоко,груша,банан"
$fruits = $text.Split(",")

5. Замена подстрок: С помощью метода .Replace() можно заменить подстроку в строке. Пример:

$text = "Привет, мир!"
$modifiedText = $text.Replace("мир", "вселенная")

6. Обрезка строк: Методы .Trim(), .TrimStart() и .TrimEnd() удаляют пробелы и другие символы в начале и конце строки.

Примеры использования методов для обрезки строк в PowerShell:

# Обрезка пробелов в начале и конце строки
$rawString = " Пример строки с пробелами "
$trimmedString = $rawString.Trim()
Write-Host "Исходная строка: '$rawString'"
Write-Host "Обрезанная строка: '$trimmedString'"
# Обрезка только в начале строки
$leftTrimmedString = $rawString.TrimStart()
Write-Host "Строка после обрезки в начале: '$leftTrimmedString'"
# Обрезка только в конце строки
$rightTrimmedString = $rawString.TrimEnd()
Write-Host "Строка после обрезки в конце: '$rightTrimmedString'"

При выполнении этого кода в консоли PowerShell вы увидите следующий вывод:

Исходная строка: ' Пример строки с пробелами '
Обрезанная строка: 'Пример строки с пробелами'
Строка после обрезки в начале: 'Пример строки с пробелами '
Строка после обрезки в конце: ' Пример строки с пробелами'

В данном примере видно, как методы .Trim(), .TrimStart() и .TrimEnd() удаляют пробелы в начале и конце строки, соответственно.

Working With Breakpoints in PowerShell

Breakpoints are incredibly useful for understanding what happens when a script is executed.

When you run a script, the code executes line by line, and various actions occur within the PowerShell session. These actions could involve declaring variables or establishing a remoting session. Normally, these activities are hidden from view, unless an error occurs or the script is designed to reveal what’s happening behind the scenes (e.g., by adding a line of code to display a variable’s contents solely for debugging purposes).

This is where breakpoints come in. A breakpoint is a designated point in the script where execution is paused.

The role of breakpoints

What makes breakpoints so interesting and helpful is that while the script execution is paused, your PowerShell session remains active. This means you can manually interact with PowerShell mid-script!

For instance, let’s say you have a complex PowerShell script that just isn’t working correctly. In such a case, you can set up a breakpoint at a strategic position within the script. When you execute the script, it will proceed normally until it reaches the breakpoint. When it does, you have the freedom to manually inspect the value of variables used in the script and interact with the session in any other useful manner. 

How to use a line breakpoint

Now that I have explained the concept and functioning of breakpoints, let’s look at how to use them.

The first step is to enter your code into PowerShell ISE and save it. Once the code is saved, you can proceed to set a breakpoint. To set one, right-click on the desired line of code and select the “Toggle Breakpoint” command from the shortcut menu.

In Figure 1, you can see an example where I have inserted a breakpoint into my code. The line with the breakpoint line is highlighted in brown (Line 42 in the figure). The lower portion of the figure shows the code execution progress until it reaches the designated breakpoint. At that point, PowerShell says the script has encountered a breakpoint. The PowerShell prompt then changes to indicate that you are now in debugging mode.

PowerShell Debug 1-1

I have set a breakpoint on Line 42 of this script.

Now check out Figure 2. I have entered the name of one of the variables used in my script, and PowerShell has displayed its current value.

PowerShell Debug 1-2

The prompt has changed to indicate the debugging mode.

It’s important to turn off debugging mode when you are done. Otherwise, you can’t make any edits to your script. To turn off debugging, simply click on the Debug menu and select the “Stop Debugger” command.

Variable and command breakpoints

The example I previously demonstrated is a line breakpoint. However, you can also create variable breakpoints and command breakpoints.

• Variable breakpoints trigger whenever a specific variable’s value changes.

• Command breakpoints trigger whenever a specific command is about to be executed.

Breakpoint ID numbers

Now let’s discuss the another important aspect of breakpoints. You can create multiple breakpoints for a single script. When doing so, each breakpoint is assigned a unique ID number. You can see the existing breakpoints along with their IDs by typing Get-PSBreakpoint.

Remove-Breakpoint -ID 3

Чем PowerShell отличается от cmd

Рассмотрим сравнение двух основных инструментов командной строки в операционной системе Windows: PowerShell и командной строки (cmd). Оба инструмента позволяют взаимодействовать с операционной системой через команды и сценарии, однако они существенно различаются по своим характеристикам и функциональности.

Debugging with Visual Studio Code

To debug a script, you can use the Wait-Debugger cmdlet within your script to pause the script until a debugger is attached. You can then use a debugger, like VS Code, to attach to the process and runspace to view variables, step through code and execute debugging commands.

You can also debug scripts using the built in Enter-PSHostProcess, Get-Runspace and Debug-Runspace cmdlets.

Для чего нужен PowerShell

PowerShell — это мощный инструмент для автоматизации задач, управления операционной системой и взаимодействия с различными приложениями и сервисами. Он широко используется администраторами систем, разработчиками, а также специалистами в области IT для решения разнообразных задач. Вот некоторые из основных применений PowerShell:

1. Автоматизация задач: PowerShell позволяет создавать сценарии (скрипты) для автоматизации повторяющихся и рутинных задач, таких как установка программ, настройка системных параметров, копирование файлов и многие другие операции.
2. Управление системой: PowerShell предоставляет доступ к широкому спектру системных функций, позволяя администраторам управлять пользователями, группами, службами, процессами, реестром и другими системными ресурсами.
3. Конфигурация и развертывание: С помощью PowerShell можно создавать и применять конфигурации для развертывания и управления серверами и компьютерами, что делает процесс управления парком устройств более эффективным.
4. Мониторинг и анализ: PowerShell позволяет анализировать системные данные, собирать статистику, мониторить производительность и события, что помогает администраторам быстро реагировать на проблемы.
5. Взаимодействие с внешними приложениями и службами: PowerShell может взаимодействовать с другими приложениями и службами, используя API, веб-службы, REST API и другие протоколы, что позволяет автоматизировать процессы, связанные с сторонними приложениями.
6. Разработка и тестирование: Разработчики используют PowerShell для создания сценариев тестирования, сборки проектов, управления версиями и других задач, связанных с разработкой ПО.
7. Обработка данных: PowerShell предоставляет мощные инструменты для обработки и анализа данных, таких как текстовые файлы, CSV, XML и другие форматы данных.
8. Безопасность: PowerShell может использоваться для управления политиками безопасности, мониторинга событий безопасности, а также для проведения аудитов безопасности системы.

Visual Studio Remote Debugger

Using the PowerShell Universal Visual Studio Code Extension, you can connect directly to your PowerShell scripts running PowerShell Universal.

Работа с файлами

PowerShell предоставляет удобные средства для работы с файлами. Вот некоторые ключевые методы:

Для создания файла используйте командлет New-Item с указанием пути к файлу:

New-Item -Path "C:\путь\к\файлу\новыйфайл.txt" -ItemType File

Чтобы записать данные в файл, используйте Out-File или Set-Content:

"Содержимое файла" | Out-File -FilePath "C:\путь\к\файлу\новыйфайл.txt"
Set-Content -Path "C:\путь\к\файлу\новыйфайл.txt" -Value "Новое содержимое файла"

Для чтения содержимого файла в массив используйте Get-Content:

$содержимое = Get-Content -Path "C:\путь\к\файлу\новыйфайл.txt"

Для получения информации о файле (размер, дата создания и др.) используйте Get-Item:

$информацияОФайле = Get-Item -Path "C:\путь\к\файлу\новыйфайл.txt"

Для копирования файла в другое место используйте Copy-Item:

Copy-Item -Path "C:\путь\к\файлу\новыйфайл.txt" -Destination "C:\путь\к\копия\новыйфайл.txt"

Для удаления файла воспользуйтесь командлетом Remove-Item:

Remove-Item -Path "C:\путь\к\файлу\новыйфайл.txt" -Force

Помните, что операции удаления файлов необратимы, поэтому будьте осторожны при их использовании.

Got a PowerShell script that isn’t working as intended? Debug it using breakpoints and a few simple steps in VS Code, and you’ll be on your way to scripting success.

Most PowerShell scripts are complex, so it’s nearly impossible to write a perfect one the first time. That’s nothing to be ashamed of. You can always debug it.

Effectively debugging a PowerShell script is a critical skill for any script writer, from a new desktop support technician to a seasoned developer. You must understand how to use breakpoints and know how to navigate the debugger in the PowerShell extension for Visual Studio (VS) Code.

If you open a PS1 file in VS Code and you don’t already have the PowerShell extension, you will be prompted to install it.

If you need to install it manually, go to the extension icon and search for “PowerShell.”

Understand breakpoints

To set breakpoints in VS Code, put the cursor on the line that you wish to add a breakpoint to and press the F9 key. You can also hover your mouse over the left margin and click on the red dot, as shown in Figure 3.

Once you set the breakpoint, it will be indicated by a bright red dot, as shown in Figure 4.

Breakpoints also show up in the breakpoint list at the bottom of the debugger pane as seen in Figure 5. You can enable or disable breakpoints from the debugger pane.

How to debug

$azPricesApiBase = "https://prices.azure.com/api/retail/prices"
$filters = @( "serviceName eq 'Virtual Machines'", "priceType eq 'Reservation'", "armRegionName eq 'westus3'"
)
$url = "$azPricesApiBase?$filter=$($filters -join ' and ')"
$items = & { $out = Invoke-RestMethod $url $out while ($null -ne $out.NextPageLink) { $out = Invoke-RestMethod $out.NextPageLink $out }
}
$items | Export-Excel -Path "C:\temp\azPrices.xlsx" -AutoSize -TableName "AzurePrices"

The goal in this example is to pull all virtual machine reservation pricing from the West US 3 region. Because the API paginates, you must execute multiple queries to get all the data.

If you execute this script in PowerShell, it throws an error.

The error suggests that something is wrong with the URL. Open the script in VS Code and start debugging.

First, put a breakpoint on Line 10 because that is where the error occurs.

Next, start the script in debugging mode. To do this, press F5 on your keyboard, or go to the Run menu and select Start Debugging. When the script gets down to Line 10, it pauses on the breakpoint and highlights the line, as shown in Figure 7.

Then examine the URL variable while the debugger has the script paused. You can see the contents of $url either by typing “$url” into the terminal or by expanding the appropriate scope of variables in the debugger under the Script section and scrolling down to $url, as seen in Figure 8.

The entire first part of the URL that is present in the $azPricesApiBase variable isn’t visible. If you scroll up to that variable or type it into the terminal, you’ll find that it does have value, as shown in Figure 9.

Something unexpected occurs on Line 7 where you are building the $url variable.

In this case, there are two problems:

• PowerShell interprets the question mark as part of the variable name. If this happens, you need to escape the question mark.
• The API requires the literal string “$filter” as part of the query parameters. If this happens, you need to escape the dollar sign because the string is within double quotes.

After fixing both issues, Line 7 now looks like this:

$url = "$azPricesApiBase`?`$filter=$($filters -join ' and ')"

Next, click the Stop button to stop the debugger.

Then execute the script again to find that the $url looks correct.

The script runs successfully to completion, except the data that was expected in the spreadsheet is completely different.

Add more break points on Lines 11, 14 and 18 so you can review the data being retrieved.

Afterwards, when you execute the script and it stops on Line 11, look at the $out variable. The information you want is in a sub-property named Items.

Track the value of $out. Right click on it and select Watch. It will stay in the Watch section of the debugger pane.

If you want the script to continue, use the debugger controls. The options are Continue, Step Over, Step Into, Step Out and Stop, as seen in Figure 15.

• Continue. Continues to the next break point or the end of the script.
• Step Over. Continues to the next statement in the current execution context.
• Step Into. Continues to the next statement, including nested execution contexts such as function calls.
• Step Out. In a nested execution context, the debugger will proceed until the current execution context is exited.
• Stop. Halts the debugging and exits the debugger.

In this case, click Continue to get to the next breakpoint. Press F5 on the keyboard or the Continue button on the debugger controls, as seen in Figure 16.

On Line 14, the value of $out is similar. It shows the desired output in the Items property. Stop the debugging, and fix Lines 11 and 14 to reference the Items property.

$out.Items

Finally, remove all the breakpoints and execute the script. The data you expect to see should show up in the spreadsheet.

The importance of variables

It is important to use variables wherever possible to easily debug a code. Variables make it easy to understand what the script executes and how it interacts with cmdlets and functions.

For example, if the script had built the URL in line with the Invoke-RestMethod cmdlet on Line 10, it would have made it more difficult to understand why the URL was incorrect because it would have been present in the debugger. That is what the $url variable defined on Line 7.

Anthony Howell is an IT expert who is well-versed in multiple infrastructure and automation technologies, including PowerShell, DevOps, cloud computing, and the Windows and Linux operating systems.

Debugging Scripts from a PowerShell Console

You can debug any script within Universal (or any PowerShell process, really) using the debugging cmdlets that are available in PowerShell. These cmdlets allow you to connect to local PowerShell processes, like Universal, and step through your scripts right in the terminal.

Pausing the Script

First, you will need to ensure that the script will wait for you to connect the debugger before continuing. This means that you’ll need to include a Wait-Debugger command somewhere in your script.

Dashboards will only wait 10 seconds during startup so putting a Wait-Debugger in them may not work. You should rely on the use of $DebugPreference and Write-Debug to diagnosis dashboard startup issues.

Executing your script

Now that you have your script setup to pause and wait for the debugger, you will want to execute your script. For jobs, just start the job. For APIs, you will need to make a request to the API via the endpoint you are trying to test. For dashboards, you will want to load the page in your browser. For authentication and authorization, you will want to login.

Finding your process ID

Once you have your Wait-Debugger command in the script that you want to debug, you’ll need to start the script and determine the process it is running within.

Jobs run in their own isolated process within Universal. All you will have to do is start the job and it will start the process and wait on your Wait-Debugger command. Once your job has started, you can use the Get-UAJob cmdlet to find that job’s process ID.

APIs run in a single PowerShell process. It does not start a new process for each API call. You can locate the API process by finding the pwsh or PowerShell process with the command line that includes StartApi.

Authentication and Authorization

Authentication and authorization scripts run within the Universal server. You can find the Universal.Server.exe process and attach to that.

Any feature running within the integrated environment will be running within the Universal.Server.exe process. You will need to attach to this process in order to debug them.

Attaching to the Process and Debugging the Runspace

Once you have the process that you want to attach to, you can do so by using Enter-PSHostProcess . Simply specify the process ID that you found in the previous step.

Enter-PSHostProcess uses named pipes and requires that you have permission to the process that you are accessing. If you are running Universal as a service you may need to run it as your local account to properly connect to the process.

Once you have attached to the process, you will now want to find the runspace where your code is running. To do so, you can use the Get-Runspace cmdlet. This will return a list of runspaces currently active in your process. Look for the runspace marked InBreakpoint. This is the runspace waiting on the Wait-Debugger command.

Now that you found your runspace, use Debug-Runspace to attached to the runspace. You will now have the opportunity to issue debugging commands against that runspace. You can view the status of variables, issue commands and even step through the script.

For a full list of debugging commands, you can see the Microsoft documentation here.

Example of Connecting to API Process

Похожее:

Windows 10 1080P, 2K, 4K, 5K HD wallpapers free download | Wallpaper Flare «Изменение размера шрифта для устройств Nokia по сравнению с изменением общего масштаба шрифта приложения на Android с использованием Configuration.fontScale»? Управление VirtualBox из командной строки | Информационный портал К2® Как сделать скриншот на ноутбуке и компьютере. Инструкция