Поиск по сайту:

New-Alias (Microsoft.PowerShell.Utility)

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

Псевдонимы:

cf

Позиция:

Именованный

Значение по умолчанию:

False

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Description

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

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Force

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

Тип :

SwitchParameter

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Name

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

Тип :

String

Позиция:

0

Значение по умолчанию:

None

Необходимый:

True

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

False

-Option

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

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

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

Чтобы просмотреть свойство Options всех псевдонимов в сеансе, введите Get-Alias | Формат-Таблица-Имя свойства, Параметры-Авторазмер.

Тип :

ScopedItemOptions

Принятые значения:

Нет, только для чтения, постоянный, частный, AllScope, не указано

Позиция:

Именованный

Значение по умолчанию:

[System.Management.Automation.ScopedItemOptions]::Нет

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-PassThru

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

Тип :

SwitchParameter

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Scope

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

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

Локальный — значение по умолчанию. Дополнительные сведения см. в разделе about_Scopes.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Value

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

Тип :

String

Позиция:

1

Значение по умолчанию:

None

Необходимый:

True

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

False

-WhatIf

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

Тип :

SwitchParameter

Псевдонимы:

wi

Позиция:

Именованный

Значение по умолчанию:

False

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

Входы

Нет

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

Выходы

Нет

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

Информация об псевдониме

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

Примечания

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

  • Все платформы:

      nal

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