Поделиться через

New-Alias

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

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

Синтаксис

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

Описание

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

Примеры

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

PS C:\> New-Alias -Name "List" Get-ChildItem

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

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

PS C:\> New-Alias -Name "W" -Value Get-WmiObject -Description "quick wmi alias" -Option ReadOnly
PS C:\> Get-Alias -Name "W" | Format-List *

Эта команда создает псевдоним W для представления командлета Get-WmiObject. Он создает описание, быстрый псевдоним WMI для псевдонима и делает его доступным только для чтения. Последняя строка команды использует Get-Alias для получения нового псевдонима и его канала для Format-List для отображения всех сведений об этом.

Параметры

-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 псевдонима. Допустимые значения:

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

Чтобы просмотреть свойство 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

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

  • Глобальный
  • Местный
  • Сценарий
  • Число относительно текущей области (от 0 до числа областей, где 0 является текущей областью, а 1 — родительским).

Локальный — это значение по умолчанию. Дополнительные сведения см. в 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 or System.Management.Automation.AliasInfo

При использовании параметра PassthruNew-Alias создается объект System.Management.Automation.AliasInfo, представляющий новый псевдоним. В противном случае этот командлет не создает выходные данные.

Примечания

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