about_Command_Syntax

Назначение: Windows PowerShell 2.0, Windows PowerShell 3.0

Вставьте сюда введение.

РАЗДЕЛ

about_Command_Syntax

КРАТКОЕ ОПИСАНИЕ

Описание диаграмм синтаксиса, используемых в Windows PowerShell®.

ПОДРОБНОЕ ОПИСАНИЕ

Командлеты Get-Help и Get-Command отображают диаграммы синтаксиса для правильного построения команд. В этом разделе содержатся сведения об интерпретации диаграмм синтаксиса.

ДИАГРАММЫ СИНТАКСИСА

Каждый абзац в диаграмме синтаксиса команды представляет допустимую форму команды.

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

Windows PowerShell использует следующую запись диаграмм синтаксиса.

       <command-name> -<Required Parameter Name> <Required Parameter Value>
                      [-<Optional Parameter Name> <Optional Parameter Value>] 
                      [-<Optional Switch Parameters>] 
                      [-<Optional Parameter Name>] <Required Parameter Value> 

Ниже приведен синтаксис для командлета New-Alias.

        New-Alias [-Name] <string> [-Value] <string> [-Description <string>]
            [-Force] [-Option {None | ReadOnly | Constant | Private | AllScope}]
            [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

Синтаксис приводится в верхнем регистре для удобства чтения, но Windows PowerShell не учитывает регистр.

Диаграмма синтаксиса содержит следующие элементы.

ИМЯ КОМАНДЫ

------------

Команды всегда начинаются с имени команды, например New-Alias. Введите имя команды или ее псевдоним, например «gcm» для Get-Command.

ПАРАМЕТРЫ

----------

Параметры команды определяют, что делает команда. Некоторые параметры принимают «значение», являющееся входными данными, вводимыми пользователем для команды.

Например, команда Get-Help имеет параметр Name, который позволяет указать имя раздела, для которого отображается справка. Имя раздела является значением параметра Name.

В команде Windows PowerShell имена параметров всегда начинается с дефиса. Дефис указывает Windows PowerShell, что элемент в команде является именем параметра.

Например, для использования параметра Name команды New-Alias введите:

        -Name

Параметры могут быть обязательными или необязательными. В диаграмме синтаксиса необязательные элементы заключаются в квадратные скобки ([ ]).

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

ЗНАЧЕНИЯ ПАРАМЕТРОВ

----------------

Значение параметра представляет собой входные данные, которые принимает параметр. Поскольку в основе Windows PowerShell лежит платформа Microsoft .NET Framework, значения параметров представлены в диаграмме синтаксиса по их типу .NET.

Например, параметр Name команды Get-Help принимает строковое значение, являющееся текстовой строкой, например, одно слово или несколько слов, заключенных в кавычки.

        [-Name] <string>

Тип .NET значения параметра заключается в угловые скобки (< >), чтобы указать, что это заполнитель для значения, а не вводимый в команду литерал.

Чтобы использовать параметр, замените заполнитель типа .NET объектом, имеющим указанный тип .NET.

Например, чтобы использовать параметр Name, введите «-Name» и затем строку следующего вида.

        -Name MyAlias

ПАРАМЕТРЫ БЕЗ ЗНАЧЕНИЙ

-------------------------

Некоторые параметры не принимают входные данные, поэтому они не имеют значения параметра. Параметры без значений называются параметрами-переключателями, поскольку они работают как переключатели. Их можно включить в команду или исключить из нее.

Чтобы использовать параметр-переключатель, просто введите имя параметра, поставив перед ним дефис.

Например, чтобы использовать параметр WhatIf командлета New-Alias, введите следующее.

        -WhatIf

НАБОРЫ ПАРАМЕТРОВ

--------------

Параметры команды перечислены в наборах параметров. Наборы параметров схожи с абзацами диаграммы синтаксиса.

Командлет New-Alias имеет один набор параметров, однако многие командлеты располагают несколькими наборами параметров. Некоторые параметры командлетов уникальны для набора параметров, а другие можно встретить в нескольких наборах параметров.

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

Например, командлет Get-Random имеет следующие наборы параметров.

        Get-Random [[-Maximum] <Object>] [-Minimum <Object>] [-SetSeed <int>]
                    [<CommonParameters>]

        Get-Random [-InputObject] <Object[]> [-Count <int>] [-SetSeed <int>]
                   [<CommonParameters>]

Первый набор параметров, который возвращает случайное число, имеет параметры Minimum и Maximum. Второй набор параметров, который возвращает случайно выбранный объект из набора объектов, содержит параметры InputObject и Count. Оба набора параметра имеют параметр Set-Seed и общие параметры.

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

Определить нужный набор параметров для использования можно с помощью параметров в этом наборе.

Однако каждый командлет также имеет набор параметров по умолчанию. Набор параметров по умолчанию используется, если не указаны уникальные параметры для набора параметров. Например, если используется команда Get-Random без параметров, Windows PowerShell предполагает, что применяется набор параметров Number, и возвращает случайное число.

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

СИМВОЛЫ В ДИАГРАММАХ СИНТАКСИСА

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

В диаграммах синтаксиса используются следующие символы.

– Дефис (-) указывает имя параметра. В команде дефис вводится непосредственно перед именем параметра без промежуточных пробелов, как показано в диаграмме синтаксиса.

Например, чтобы использовать параметр Name команды New-Alias введите:

           -Name 

– Угловые скобки (<>) указывают текст заполнителя. В команде угловые скобки или текст заполнителя не вводятся. Они заменяются описывающим их элементом.

Угловые скобки используются для указания типа .NET значения, которое принимает параметр. Например, чтобы использовать параметр Name командлета New-Alias, замените элемент <строка> на строку, которая является одним словом или набором слов, заключенных в кавычки.

– Квадратные скобки ([ ]) указывают необязательные элементы. Параметр и его значение могут быть необязательными. Необязательным может быть имя обязательного параметра.

Например, параметр Description команды New-Alias и его значение заключаются в квадратные скобки, поскольку они оба являются необязательными.

   [-Description <string>]

Квадратные скобки также указывают, что значение параметра Name (<строка>) является обязательным, а имя параметра («Name») — необязательным.

         [-Name] <string>

– Правая и левая скобки ([]), добавленные к типу .NET, указывают, что параметр может принимать одно или несколько значений этого типа. Введите значения в список с разделителями-запятыми.

Например, параметр Name командлета New-Alias принимает только одну строку, но параметр Name командлета Get-Process может принимать одну или несколько строк.

          New-Alias [-Name] <string>

               New-Alias -Name MyAlias

          Get-Process [-Name] <string[]>

               Get-Process -Name Explorer, Winlogon, Services
               

– Фигурные скобки ({}) указывают перечисление, представляющее собой набор допустимых значений для параметра.

Значения в фигурных скобках разделяются символом вертикальной черты (|). Эти полосы указывают выбор исключающего ИЛИ, что означает, что можно выбрать только одно значение из набора значений, которые указаны внутри фигурных скобок.

Например, синтаксис для командлета New-Alias содержит следующее перечисление значений для параметра Option.

          -Option {None | ReadOnly | Constant | Private | AllScope}

Фигурные скобки и вертикальные полосы указывают, что можно выбрать одно любое из перечисленных значений для параметра Option, например ReadOnly или AllScope.

          -Option ReadOnly

НЕОБЯЗАТЕЛЬНЫЕ ЭЛЕМЕНТЫ

Необязательные элементы заключаются в квадратные скобки ([]). Например, в описании синтаксиса командлета 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. В этом контексте квадратные скобки не означают, что элемент является необязательным.

КЛЮЧЕВЫЕ СЛОВА

about_Symbols

about_Punctuation

about_Help_Syntax

СМ. ТАКЖЕ

about_Parameters

Get-Command

Get-Help