New-Alias

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Создает новый псевдоним.

Синтаксис

New-Alias
   [-Name] <String>
   [-Value] <String>
   [-Description <String>]
   [-Option <ScopedItemOptions>]
   [-PassThru]
   [-Scope <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Описание

Командлет New-Alias создает новый псевдоним в текущем сеансе PowerShell. Псевдонимы, созданные с помощью, New-Alias не сохраняются после выхода из сеанса или закрытия PowerShell. С помощью командлета Export-Alias можно сохранить сведения о псевдониме в файл. Позже можно использовать Import-Alias для получения сведений о сохраненных псевдонимах.

Примеры

Пример 1. Создание псевдонима для командлета

New-Alias -Name "List" Get-ChildItem

Эта команда создает псевдоним с именем List для представления командлета Get-ChildItem.

Пример 2. Создание псевдонима только для чтения для командлета

Эта команда создает псевдоним с именем C для представления командлета Get-ChildItem . Он создает описание "быстрого псевдонима gci" для псевдонима и делает его доступным только для чтения.

New-Alias -Name "C" -Value Get-ChildItem -Description "quick gci alias" -Option ReadOnly
Get-Alias -Name "C" | Format-List *

HelpUri             : https://go.microsoft.com/fwlink/?LinkID=2096492
ResolvedCommandName : Get-ChildItem
DisplayName         : C -> Get-ChildItem
ReferencedCommand   : Get-ChildItem
ResolvedCommand     : Get-ChildItem
Definition          : Get-ChildItem
Options             : ReadOnly
Description         : quick gci alias
OutputType          : {System.IO.FileInfo, System.IO.DirectoryInfo}
Name                : C
CommandType         : Alias
Source              :
Version             :
Visibility          : Public
ModuleName          :
Module              :
RemotingCapability  : PowerShell
Parameters          : {[Path, System.Management.Automation.ParameterMetadata], [LiteralPath,
                      System.Management.Automation.ParameterMetadata], [Filter,
                      System.Management.Automation.ParameterMetadata], [Include,
                      System.Management.Automation.ParameterMetadata]…}

В конвейере Get-Alias команды отображаются Format-List все сведения о новом псевдониме.

Пример 3. Создание псевдонима для команды с параметрами

function Set-ParentDirectory {Set-Location -Path ..}
New-Alias -Name .. -Value Set-ParentDirectory

Первая команда создает функцию Set-ParentDirectory, которая используется Set-Location для задания рабочего расположения родительскому каталогу. Вторая команда используется New-Alias для создания псевдонима .. для вызова Set-ParentDirectory функции. Так как для параметра Value требуется командлет, функция или исполняемое значение, необходимо создать пользовательскую функцию, чтобы создать псевдоним, использующий параметры. При выполнении .. псевдонима изменяется текущее расположение родительского каталога.

Параметры

-Confirm

Запрос подтверждения перед выполнением командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Description

Указывает описание псевдонима. Можно ввести любую строку. Если описание содержит пробелы, заключите его в кавычки.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Force

Указывает, что командлет действует так Set-Alias , если псевдоним уже существует.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Name

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

Тип:String
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Option

Задает значение свойства Options псевдонима. Допустимые значения:

  • None: псевдоним не имеет ограничений (значение по умолчанию)
  • ReadOnly: псевдоним можно удалить, но не может быть изменен, за исключением использования параметра Force
  • Constant: псевдоним нельзя удалить или изменить
  • Private: псевдоним доступен только в текущей области
  • AllScope: псевдоним копируется в любые новые области, созданные
  • Unspecified: параметр не указан

Эти значения определяются как перечисление на основе флага. Можно объединить несколько значений, чтобы задать несколько флагов с помощью этого параметра. Значения можно передать параметру Option в виде массива значений или в виде строки, разделенной запятыми этих значений. Командлет объединяет значения с помощью операции binary-OR. Передача значений в виде массива является самым простым параметром, а также позволяет использовать завершение табуляции для значений.

Чтобы просмотреть свойство Options всех псевдонимов в сеансе, введите Get-Alias | Format-Table -Property Name, Options -AutoSize.

Тип:ScopedItemOptions
Допустимые значения:None, ReadOnly, Constant, Private, AllScope, Unspecified
Position:Named
Default value:[System.Management.Automation.ScopedItemOptions]::None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-PassThru

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

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Scope

Указывает область действия нового псевдонима. Допустимые значения для этого параметра:

  • Global
  • Local
  • Script
  • Число относительно текущей области (от 0 до числа областей, где 0 находится текущая область и 1 является ее родительским).

Значение по умолчанию — Local. Дополнительные сведения см. в about_Scopes.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Value

Указывает имя командлета или элемента команды, для которого создается псевдоним.

Тип:String
Position:1
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

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

None

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

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

None

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

AliasInfo

При использовании параметра PassThru этот командлет возвращает объект AliasInfo , представляющий новый псевдоним.

Примечания

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

  • Для всех платформ.

    • nal

  • Чтобы создать новый псевдоним, используйте Set-Alias или New-Alias. Чтобы изменить псевдоним, используйте Set-Alias. Чтобы удалить псевдоним, используйте Remove-Alias.