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. Создание псевдонима только для чтения для командлета

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

Эта команда создает псевдоним с именем C для представления командлета Get-ChildItem . Он создает описание, быстрый псевдоним WMI для псевдонима и делает его доступным только для чтения. Последняя строка команды использует Get-Alias для получения нового псевдонима и передает его в формат списка, чтобы отобразить все сведения о нем.

Параметры

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Option

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

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

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

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

Type:ScopedItemOptions
Accepted values:None, ReadOnly, Constant, Private, AllScope, Unspecified
Position:Named
Default value:[System.Management.Automation.ScopedItemOptions]::None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

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

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

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Value

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

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

None

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

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

None

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

AliasInfo

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

Примечания

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

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

    • nal

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