Show-Command (Microsoft.PowerShell.Utility)

Show-Command

Модуль:: Microsoft.PowerShell.Utility

Отображает информацию о командах PowerShell в графическом окне.

Синтаксис

Show-Command
    [[-Name] <String>]
    [-Height <Double>]
    [-Width <Double>]
    [-NoCommonParameter]
    [-ErrorPopup]
    [-PassThru]
    [<CommonParameters>]

Описание

Этот командлет доступен только на платформе Windows.

Командлет Show-Command позволяет создать команду PowerShell в командном окне. Вы можете использовать функции командного окна для запуска команды или вернуть ее вам.

Show-Command — очень полезный инструмент преподавания и обучения. Show-Command работает со всеми типами команд, включая командлеты, функции, рабочие процессы и команды CIM.

Без параметров Show-Command отображает командное окно, в котором перечислены все доступные команды во всех установленных модулях. Чтобы найти команды в модуле, выберите модуль из раскрывающегося списка «Модули». Чтобы выбрать команду, щелкните имя команды.

Чтобы использовать окно команд, выберите команду, используя имя или щелкнув имя команды в списке Команды. Каждый набор параметров отображается на отдельной вкладке. Звездочки указывают обязательные параметры. Чтобы ввести значения параметра, введите значение в текстовое поле или выберите значение из раскрывающегося списка. Чтобы добавить параметр переключателя, установите флажок параметра.

Когда вы будете готовы, вы можете нажать Копировать, чтобы скопировать созданную вами команду в буфер обмена, или нажать Выполнить, чтобы запустить команду. Вы также можете использовать параметр PassThru, чтобы вернуть команду в ведущую программу, например в консоль PowerShell. Чтобы отменить выбор команды и вернуться к виду, отображающему все команды, нажмите клавишу Ctrl и щелкните выбранную команду.

В интегрированной среде сценариев PowerShell (ISE) по умолчанию отображается вариант окна Show-Command. Информацию об использовании этого командного окна см. в разделах справки PowerShell ISE.

Этот командлет был вновь представлен в PowerShell 7.

Поскольку для этого командлета требуется пользовательский интерфейс, он не работает в Windows Server Core или Windows Nano Server. Этот командлет доступен только в системах Windows, поддерживающих рабочий стол Windows.

Примеры

Пример 1. Откройте окно «Команды».

В этом примере отображается вид по умолчанию для окна Show-Command. В окне Команды отображается список всех команд всех модулей, установленных на компьютере.

Show-Command

Пример 2. Откройте командлет в окне «Команды».

В этом примере командлет Invoke-Command отображается в окне Command. Вы можете использовать этот экран для запуска команд Invoke-Command.

Show-Command -Name "Invoke-Command"

Пример 3. Откройте командлет с указанными параметрами.

Эта команда открывает окно Show-Command для командлета Connect-PSSession.

Show-Command -Name "Connect-PSSession" -Height 700 -Width 1000 -ErrorPopup

Параметры Высота и Ширина определяют размер командного окна. Параметр ErrorPopup отображает окно команды ошибки.

При нажатии кнопки Выполнить запускается команда Connect-PSSession, как если бы вы ввели команду Connect-PSSession в командной строке.

Пример 4. Указание новых значений параметров по умолчанию для командлета

В этом примере используется автоматическая переменная $PSDefaultParameterValues для установки новых значений по умолчанию для параметров Height, Width и ErrorPopup. командлета Show-Command.

$PSDefaultParameterValues = @{
    "Show-Command:Height" = 700
    "Show-Command:Width" = 1000
    "Show-Command:ErrorPopup" = $True
}

Теперь, когда вы запускаете команду Show-Command, новые значения по умолчанию применяются автоматически. Чтобы использовать эти значения по умолчанию в каждом сеансе PowerShell, добавьте переменную $PSDefaultParameterValues в свой профиль PowerShell. Дополнительные сведения см. в разделах about_Profiles и about_Parameters_Default_Values.

Пример 5. Отправка вывода в виде сетки

Эта команда показывает, как совместно использовать командлеты Show-Command и Out-GridView.

Show-Command Get-ChildItem | Out-GridView

Команда использует командлет Show-Command, чтобы открыть командное окно для командлета Get-ChildItem. При нажатии кнопки Выполнить запускается команда Get-ChildItem и генерирует выходные данные. Оператор конвейера ( | ) отправляет выходные данные команды Get-ChildItem в командлет Out-GridView, который отображает выходные данные Get-ChildItem. в интерактивном окне.

Пример 6. Отображение команды, созданной вами, в окне «Команды».

В этом примере показана команда, созданная вами в окне Show-Command. Команда использует параметр PassThru, который возвращает результаты Show-Command в виде строки.

Show-Command -PassThru

Get-EventLog -LogName "Windows PowerShell" -Newest 5

Например, если вы используете окно Show-Command для создания команды Get-EventLog, которая получает пять новейших событий в журнале событий Windows PowerShell, а затем нажимаете ОК, команда возвращает вывод, показанный выше. Просмотр командной строки поможет вам изучить PowerShell.

Пример 7. Сохранение команды в переменной

В этом примере показано, как запустить командную строку, полученную при использовании параметра PassThru командлета Show-Command. Эта стратегия позволяет вам увидеть команду и использовать ее.

$C = Show-Command -PassThru
$C
Invoke-Expression $C

Get-EventLog -LogName "PowerShell" -Newest 5

Index Time          EntryType   Source                 InstanceID Message
----- ----          ---------   ------                 ---------- -------
11520 Dec 16 16:37  Information Windows PowerShell            400 Engine state is changed from None to Available...
11519 Dec 16 16:37  Information Windows PowerShell            600 Provider "Variable" is Started. ...
11518 Dec 16 16:37  Information Windows PowerShell            600 Provider "Registry" is Started. ...
11517 Dec 16 16:37  Information Windows PowerShell            600 Provider "Function" is Started. ...
11516 Dec 16 16:37  Information Windows PowerShell            600 Provider "FileSystem" is Started. ...

Первая команда использует параметр PassThru командлета Show-Command и сохраняет результаты команды в переменной $C. В этом случае мы используем окно Show-Command для создания команды Get-EventLog, которая получает пять новейших событий в журнале событий Windows PowerShell. Когда вы нажимаете ОК, Show-Command возвращает командную строку, которая сохраняется в переменной $C.

Пример 8. Сохранение вывода команды в переменную.

В этом примере используется параметр ErrorPopup для сохранения вывода команды в переменной.

$P = Show-Command Get-Process -ErrorPopup
$P

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    473      33    94096     112532   709     2.06   4492 powershell

Помимо отображения ошибок в окне, ErrorPopup возвращает выходные данные текущей команды вместо создания новой команды. При запуске этой команды открывается окно Show-Command. Вы можете использовать функции окна для установки значений параметров. Чтобы запустить команду, нажмите кнопку Выполнить в окне Show-Command.

Параметры

-ErrorPopup

Указывает, что командлет отображает ошибки во всплывающем окне, а не только в командной строке. По умолчанию, когда команда, запущенная в окне Show-Command, генерирует ошибку, ошибка отображается только в командной строке.

Кроме того, когда вы запускаете команду (с помощью кнопки Выполнить в окне Show-Command), параметр ErrorPopup возвращает результаты команды в текущую команду вместо запуска команды и возврата ее вывода в новую команду. Эту функцию можно использовать для сохранения результатов команды в переменной.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: False
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Height

Указывает высоту окна Show-Command в пикселях. Введите значение от 300 до количества пикселей в разрешении экрана. Если значение слишком велико для отображения окна команд на экране, Show-Command выдаст ошибку. Высота по умолчанию составляет 600 пикселей. Для команды Show-Command, включающей параметр Name, высота по умолчанию составляет 300 пикселей.

Тип :: Двойной
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Name

Отображает командное окно для указанной команды. Введите имя одной команды, например имя командлета, функции или команды CIM. Если вы опустите этот параметр, Show-Command отобразит командное окно, в котором перечислены все команды PowerShell во всех модулях, установленных на компьютере.

Тип :: String
Псевдонимы:: CommandName
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-NoCommonParameter

Указывает, что в этом командлете отсутствует раздел «Общие параметры» при отображении команды. По умолчанию общие параметры отображаются в расширяемом разделе в нижней части командного окна.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: False
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-PassThru

Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию этот командлет не генерирует никаких выходных данных. Чтобы запустить командную строку, скопируйте и вставьте ее в командную строку или сохраните в переменной и используйте командлет Invoke-Expression для запуска строки в переменной.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: False
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Width

Определяет ширину окна Show-Command в пикселях. Введите значение от 300 до количества пикселей в разрешении экрана. Если значение слишком велико для отображения окна команд на экране, Show-Command выдаст ошибку. Ширина по умолчанию составляет 300 пикселей.

Тип :: Двойной
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

Входы

Нет

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

Выходы

Нет

По умолчанию этот командлет не возвращает никаких результатов.

Строка

При использовании параметра PassThru этот командлет возвращает командную строку.

Объект

При использовании параметра ErrorPopup этот командлет возвращает выходные данные команды (любой объект).

Примечания

PowerShell включает следующие псевдонимы для Show-Command:

Windows:

Этот командлет доступен только на платформах Windows.

Show-Command не работает в удаленных сеансах.