Get-Help

Модуль:

Microsoft.PowerShell.Core

Отображает сведения о командах и понятиях PowerShell.

Синтаксис

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Описание

Командлет Get-Help отображает сведения о концепциях и командах PowerShell, включая командлеты, функции, команды CIM, рабочие процессы, поставщики, псевдонимы и скрипты.

Чтобы получить справку по командлету PowerShell, введите Get-Help имя командлета, например Get-Help Get-Process.

Основные справочные статьи в PowerShell начинаются с about_, например about_Comparison_Operators. Чтобы просмотреть все about_ статьи, введите Get-Help about_*. Чтобы просмотреть определенную статью, введите Get-Help about_<article-name>, например Get-Help about_Comparison_Operators.

Чтобы получить справку по поставщику PowerShell, введите Get-Help имя поставщика. Например, чтобы получить справку по поставщику сертификатов, введите Get-Help Certificate.

Можно также ввести help или man, который отображает по одному экрану текста за раз. Или , <cmdlet-name> -?который идентичен Get-Help, но работает только для командлетов.

Get-Help получает содержимое справки, которое отображается из файлов справки на компьютере. Без файлов Get-Help справки отображает только основные сведения о командлетах. Некоторые модули PowerShell содержат файлы справки. Начиная с PowerShell 3.0 модули, которые поставляются с операционной системой Windows, не содержат файлы справки. Чтобы скачать или обновить файлы справки для модуля в PowerShell 3.0, используйте Update-Help командлет .

Вы также можете просмотреть справочные документы PowerShell в Интернете в Документация Майкрософт. Чтобы получить веб-версию файла справки, используйте параметр Online, например Get-Help Get-Process -Online. Чтобы ознакомиться со всей документацией по PowerShell, см. Документация Майкрософт документации по PowerShell.

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

Get-Help можно получить справочные статьи для всех поддерживаемых языков и языковых стандартов. Get-Help Сначала ищет файлы справки в наборе языковых стандартов для Windows, затем в родительском языковом стандарте, например pt для pt-BR, а затем в резервном языковом стандарте. Начиная с PowerShell 3.0, если Get-Help не находит справку в резервном языковом стандарте, он ищет справочные статьи на английском языке en-US, прежде чем возвращает сообщение об ошибке или отображает автоматически созданную справку.

Сведения о символах, отображаемых Get-Help на схеме синтаксиса команд, см. в разделе about_Command_Syntax. Сведения об атрибутах параметров, таких как Required и Position, см. в разделе about_Parameters.

Примечание

В PowerShell 3.0 и PowerShell 4.0 не удается найти статьи о программе в модулях, Get-Help если модуль не импортирован в текущий сеанс. Это известная проблема. Чтобы получить статьи о программе в модуле, импортируйте модуль с помощью командлета Import-Module или командлета, включенного в модуль.

Примеры

Пример 1. Отображение основных справочных сведений о командлете

В этих примерах отображаются основные справочные сведения о командлете Format-Table .

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> — это самый простой синтаксис командлета Get-Help по умолчанию. Параметр Name можно опустить.

Синтаксис <cmdlet-name> -? работает только для командлетов.

Пример 2. Отображение основных сведений по одной странице за раз

В этих примерах отображаются основные справочные сведения о командлете Format-Table по одной странице за раз.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help — это функция, которая выполняет Get-Help командлет внутри и отображает результат по одной странице за раз.

man — это псевдоним функции help .

Get-Help Format-Table отправляет объект вниз по конвейеру. Out-Host -Paging получает выходные данные из конвейера и отображает их по одной странице за раз. Дополнительные сведения см. в разделе Out-Host.

Пример 3. Отображение дополнительных сведений для командлета

В этих примерах отображаются более подробные справочные сведения о командлете Format-Table .

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

Параметр Detailed отображает подробное представление статьи справки, включающее описания параметров и примеры.

Параметр Full отображает полное представление статьи справки, включающее описания параметров, примеры, типы входных и выходных объектов, а также дополнительные примечания.

Параметры Detailed и Full действуют только для команд, у которых на компьютере установлены файлы справки. Параметры не действуют для статей справки по концептуальной (about_).

Пример 4. Отображение выбранных частей командлета с помощью параметров

В этих примерах отображаются выбранные части справки командлета Format-Table .

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Параметр Examples отображает разделы NAME и SYNOPSIS файла справки, а также все примеры. Невозможно указать число примера, так как параметр Examples является параметром switch.

Параметр Parameter отображает только описания указанных параметров. Если указать только подстановочный знак звездочки (*), отображаются описания всех параметров. Если Параметр задает имя параметра, например GroupBy, отображаются сведения об этом параметре.

Эти параметры не действуют в статьях справки по концептуальной (about_).

Пример 5. Отображение интерактивной версии справки

В этом примере показана веб-версия статьи справки для командлета Format-Table в веб-браузере по умолчанию.

Get-Help Format-Table -Online

Пример 6. Отображение справки о системе справки

Командлет Get-Help без параметров отображает сведения о системе справки PowerShell.

Get-Help

Пример 7. Отображение доступных справочных статей

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

Get-Help *

Пример 8. Отображение списка концептуальных статей

В этом примере отображается список концептуальных статей, включенных в справку По PowerShell. Все эти статьи начинаются с символов about_. Чтобы отобразить конкретный файл справки, введите Get-Help \<about_article-name\>, например Get-Help about_Signing.

Отображаются только концептуальные статьи с файлами справки, установленными на компьютере. Сведения о скачивании и установке файлов справки в PowerShell 3.0 см. в разделе Update-Help.

Get-Help about_*

Пример 9. Поиск слова в справке по командлетам

В этом примере показано, как найти слово в справочной статье командлета.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Helpиспользует параметр Full для получения справочных сведений по .Add-Member Объект MamlCommandHelpInfo отправляется по конвейеру. Out-Stringиспользует параметр Stream для преобразования объекта в строку. Select-String использует параметр Pattern для поиска в строке clixml.

Пример 10. Отображение списка статей, включающих слово

В этом примере отображается список статей, включающих слово удаленное взаимодействие.

При вводе слова, которое не отображается ни в одном заголовке статьи, Get-Help отображается список статей, включающих это слово.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Пример 11. Отображение справки для конкретного поставщика

В этом примере показаны два способа получения справки для конкретного поставщика для Get-Item. Эти команды получают справку, в которой объясняется, как использовать Get-Item командлет в узле DataCollection поставщика PowerShell SQL Server.

В первом примере используется Get-Help параметр Path для указания пути поставщика SQL Server. Так как указан путь поставщика, вы можете выполнить команду из любого расположения пути.

Во втором примере используется Set-Location для перехода к пути поставщика SQL Server. В этом расположении параметр Path не требуется для Get-Help получения справки по конкретному поставщику.

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Пример 12. Отображение справки по скрипту

Этот пример получает справку MyScript.ps1 scriptдля . Сведения о написании справки по функциям и сценариям см. в разделе about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Параметры

-Category

Выводит справку только для элементов, относящихся к указанной категории, и их псевдонимы. Концептуальные статьи находятся в категории HelpFile .

Ниже приведены допустимые значения для этого параметра.

• Псевдоним
• Командлет
• Поставщик
• Общее
• Вопросы и ответы
• Глоссарий
• HelpFile
• ScriptCommand
• Функция
• Фильтр
• ExternalScript
• Все
• DefaultHelp
• Рабочий процесс
• DscResource
• Класс
• Конфигурация

Type:	String[]
Accepted values:	Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Component

Отображает команды с указанным значением компонента, например Exchange. Введите название компонента. Можно использовать подстановочные знаки. Этот параметр не влияет на отображение концептуальной справки (About_).

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

-Detailed

Добавляет описания параметров и и примеры к основным справочным сведениям. Этот параметр действует только в том случае, если на компьютере установлены файлы справки. Он не влияет на отображение концептуальной (About_) справки.

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

-Examples

Выводит только имя, краткий обзор и параметры. Чтобы отобразить только примеры, введите (Get-Help \<cmdlet-name\>).Examples.

Этот параметр действует только в том случае, если на компьютере установлены файлы справки. Он не влияет на отображение концептуальной (About_) справки.

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

-Full

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

Этот параметр действует только в том случае, если на компьютере установлены файлы справки. Он не влияет на отображение концептуальной (About_) справки.

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

-Functionality

Выводит справку по элементам с указанными функциями. Введите функцию. Можно использовать подстановочные знаки. Этот параметр не влияет на отображение концептуальной справки (About_).

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

-Name

Возвращает справку по указанной команде или понятию. Введите имя командлета, функции, поставщика, скрипта или рабочего процесса, например Get-Member, концептуальное имя статьи, например about_Objects, или псевдоним, например ls. Подстановочные знаки разрешены в именах командлетов и поставщиков, но вы не можете использовать подстановочные знаки для поиска имен статей справки по функциям и статей справки по сценариям.

Чтобы получить справку по скрипту, который не находится в пути, указанном в $env:Path переменной среды, введите путь к скрипту и имя файла.

Если ввести точное имя статьи справки, Get-Help отобразится ее содержимое.

Если ввести слово или шаблон, который отображается в нескольких заголовках статей справки, Get-Help отобразится список соответствующих названий.

Если ввести текст, который не соответствует ни одному заголовку статей справки, Get-Help отобразится список статей, включающих этот текст в содержимое.

Имена концептуальных статей, таких как about_Objects, должны вводиться на английском языке, даже в версиях PowerShell, отличных от английского.

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-Online

Отображает веб-версию статьи справки в браузере по умолчанию. Этот параметр допустим только для статей справки по командлетам, функциям, рабочим процессам и сценариям. Параметр OnlineGet-Help нельзя использовать в удаленном сеансе.

Сведения о поддержке этой функции в статьях справки, которые вы пишете, см. в разделах about_Comment_Based_Help и Поддержка справки в Интернете и Написание справки для командлетов PowerShell.

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

-Parameter

Выводит только подробное описание указанных параметров. Разрешено использовать подстановочные знаки. Этот параметр не влияет на отображение концептуальной справки (About_).

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

-Path

Возвращает справку с описанием того, как командлет работает по указанному пути к поставщику. Введите путь поставщика PowerShell.

Этот параметр получает настраиваемую версию статьи справки по командлетам, в которой объясняется, как работает командлет по указанному пути поставщика PowerShell. Этот параметр действует только для справки о командлете поставщика и только в том случае, если поставщик включает пользовательскую версию статьи справки командлета поставщика в файл справки. Для использования этого параметра установите файл справки для модуля, включающего поставщик.

Чтобы просмотреть справку по пользовательскому командлету для пути поставщика, перейдите к расположению пути поставщика и введите Get-Help команду или в любом расположении Get-Help пути используйте параметр Path для , чтобы указать путь поставщика. Вы также можете найти справку по пользовательским командлетам в Интернете в разделе справки поставщика статей справки.

Дополнительные сведения о поставщиках PowerShell см. в разделе about_Providers.

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

-Role

Выводит справку, настроенную для указанной роли пользователя. Введите роль. Можно использовать подстановочные знаки.

Введите роль, которую пользователь имеет в организации. Для некоторых командлетов в файлах справки содержится разный текст в зависимости от значения этого параметра. Этот параметр не влияет на справку по основным командлетам.

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

-ShowWindow

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

Параметр ShowWindow поддерживает разделы справки для команд (командлеты, функции, команды CIM, скрипты) и концептуальные статьи о программе . Он не поддерживает справку по поставщикам.

Этот параметр был повторно введен в PowerShell 7.0.

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

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

None

Вы не можете отправить объекты по конвейеру в Get-Help.

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

ExtendedCmdletHelpInfo

При выполнении Get-Help команды, у которой нет файла справки, Get-Help возвращает объект ExtendedCmdletHelpInfo , представляющий автоматически созданную справку.

String

Если вы получили концептуальную справочную статью, Get-Help возвращает ее в виде строки.

MamlCommandHelpInfo

Если вы получаете команду с файлом справки, Get-Help возвращает объект MamlCommandHelpInfo .

Примечания

PowerShell 3.0 не содержит файлы справки. Чтобы скачать и установить файлы справки, которые Get-Help считываются, используйте Update-Help командлет . С помощью командлета Update-Help можно скачать и установить файлы справки для основных команд, которые поставляются в PowerShell, а также для всех установленных модулей. С его помощью можно также обновлять файлы справки на компьютере, чтобы они всегда были актуальны.

Вы также можете ознакомиться со статьями справки о командах, которые поставляются в PowerShell Online, начиная с начало работы с Windows PowerShell.

Get-Help отображает справку в наборе языковых стандартов для операционной системы Windows или на резервном языке для этого языкового стандарта. Если у вас нет файлов справки для основного или резервного языкового стандарта, служба ведет себя так, Get-Help как если бы на компьютере нет файлов справки. Чтобы получить справку по другому языковому стандарту, используйте язык и регион в панель управления, чтобы изменить параметры. В Windows 10 или более поздней версии выберите Параметры, Язык & времени.

Полное представление справки содержит таблицу сведений о параметрах. В таблице содержатся указанные ниже поля.

• Обязательно. Показывает, является ли параметр необходимым (true) или необязательным (false).

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

• Имя указывает, что имя параметра является обязательным, но параметр может отображаться в любом месте команды.

• Numeric указывает, что имя параметра является необязательным, но если имя опущено, параметр должен находиться в месте, указанном номером. Например, указывает, 2 что если имя параметра опущено, параметр должен быть вторым или только неименованным параметром в команде. Если используется имя параметра, параметр может располагаться в любом месте команды.

• Значение по умолчанию. Значение параметра или поведение по умолчанию, используемое PowerShell, если параметр не включен в команду.

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

• Принимает подстановочные знаки. Указывает, может ли значение параметра включать подстановочные знаки, такие как звездочка (*) или вопросительный знак (?).

Связанные ссылки

• about_Command_Syntax
• about_Comment_Based_Help
• Get-Command;
• Поддержка обновляемой справки
• Update-Help
• Написание разделов справки на основе комментариев
• Написание справки для командлетов PowerShell