РАЗДЕЛ
about_Command_Syntax
КРАТКОЕ ОПИСАНИЕ
Описывает синтаксис, используемый в справке для Windows PowerShell.
ПОЛНОЕ ОПИСАНИЕ
Командлет Get-Help отображает правила использования параметров
командлета. Командлет Get-Help использует следующие специальные
символы.
Угловые скобки (<>) указывают на замещающий текст.
Квадратные скобки ([]) указывают на необязательные элементы.
Фигурные скобки ({}) указываются на возможность выбора значений.
Некоторые командлеты поддерживают несколько наборов параметров.
При этом некоторые параметры могут использоваться в различных наборах
параметров. Командлет Get-Help отображает все наборы параметров
командлета.
Дополнительные сведения о параметрах можно получить из описаний
параметров и таблицы атрибутов параметров. Для просмотра полной
информации о параметре используйте параметры Full или Parameter
командлета Get-Help.
Синтаксис
В справке для командлетов Windows PowerShell, разделах справки
и другой документации используется следующий формат описания
синтаксиса командлетов.
<имя командлета> -<имя обязательного параметра>
<значение обязательного параметра>
[-<имя необязательного параметра>
<значение необязательного параметра>]
[-<необязательный параметр-переключатель>]
[-<необязательное имя параметра>]
<значение обязательного параметра>
Ниже показан синтаксис для командлета New-Alias.
New-Alias [-Force] [-PassThru] [-Scope <string>]
[-Option {None | ReadOnly | Constant | Private | AllScope}]
[-Description <string>] [-Name] <string> [-Value] <string>
[-confirm] [-whatif] [<CommonParameters>]
Заглавные буквы добавлены в синтаксис для упрощения чтения, но
оболочка Windows PowerShell не учитывает регистр символов.
Параметры отображаются в установленном порядке. Порядок
параметров имеет значение, в то время как имена параметров являются
необязательными. Если не указать имена параметров при использовании
командлета, оболочка Windows PowerShell присвоит значения параметрам
по позиции и по типу.
Перед именами параметров вводится дефис (-). Параметры-переключатели
отображаются без указания типа значения. Для других параметров указывается
требуемый тип значения (тип платформы Microsoft .NET Framework) или
перечисление возможных значений. Дополнительные сведения о типах
платформы .NET Framework см. на веб-странице
https://go.microsoft.com/fwlink/?LinkId=143682.
Угловые скобки (<>) указывают на замещающий текст. Этот текст может
описывать тип элемента (например, строковый объект или объект процесса).
Замещающий текст также может замещать один или несколько общих параметров.
Квадратные скобки ([]) указывают на необязательные элементы.
Необязательным может быть параметр или имя обязательного параметра.
Параметры-переключатели всегда являются необязательными.
В фигурные скобки ({}) заключаются значения перечисления. В
примере с командлетом New-Alias параметр Option может принимать
любое из указанных значений.
Необязательные элементы
В квадратные скобки ([]) заключаются необязательные элементы.
Например, в описании синтаксиса командлета New-Alias параметр Scope
является необязательным. На это указывают квадратные скобки вокруг
имени и типа значения параметра:
[-Scope <string>]
Ниже представлены два примера допустимого использования
командлета New-Alias.
New-Alias -Name utd -Value Update-TypeData New-Alias -Name
utd -Value Update-TypeData -Scope global
Имя параметра может быть необязательным, даже если значение этого
параметра является обязательным. На это указывают квадратные скобки
вокруг имени параметра, но не вокруг типа значения параметра, как в
следующем примере из синтаксиса командлета New-Alias:
[-Name] <string> [-Value] <string>
В следующих командах командлет New-Alias используется
корректно. Результат выполнения команд будет одинаковым.
New-Alias -Name utd -Value Update-TypeData New-Alias -Name
utd Update-TypeData
New-Alias utd -Value Update-TypeData
New-Alias utd Update-TypeData
Если имя параметра не указано во введенной инструкции, оболочка
Windows PowerShell пытается использовать позицию аргументов для
присвоения значений параметрам.
Следующий пример не является полным:
New-Alias utd
При использовании данного командлета необходимо указать значения
параметров Name и Value.
В примерах синтаксиса квадратные скобки также используются при
указании и приведении к типам платформы .NET Framework. В этом
контексте квадратные скобки не указывают на необязательность
элемента.
Аргументы массива
Квадратные скобки также используются в описаниях синтаксиса для
представления массива. В следующем примере показан синтаксис для
командлета Restart-Service.
Restart-Service [-Name] <string[]> [-Include <string[]>]
[-Exclude <string[]>] [-Force] [-PassThru] [-Confirm] [-WhatIf]
[<CommonParameters>]
Для параметра Name необходимо указать аргумент. Более конкретно,
необходимо указать имя перезапускаемой службы. Допускается
использование списка служб, разделенных запятыми, как в следующем примере:
Restart-Service RasAuto, RasMan, RemoteAccess
СМ. ТАКЖЕ
Get-Help