Set-Alias (Microsoft.PowerShell.Utility)

Set-Alias

Модуль:: Microsoft.PowerShell.Utility

Создает или изменяет псевдоним для командлета или другой команды в текущем сеансе PowerShell.

Синтаксис

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

Описание

Командлет Set-Alias создает или изменяет псевдоним для командлета или команды, например функции, сценария, файла или другого исполняемого файла. Псевдоним — это альтернативное имя, которое относится к командлету или команде. Например, sal — это псевдоним командлета Set-Alias. Дополнительные сведения см. в разделе about_Aliases.

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

Псевдоним, созданный или измененный с помощью Set-Alias, не является постоянным и доступен только во время текущего сеанса PowerShell. Когда сеанс PowerShell закрывается, псевдоним удаляется.

Примеры

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

Эта команда создает псевдоним командлета в текущем сеансе PowerShell.

PS> Set-Alias -Name list -Value Get-ChildItem

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-ChildItem

Командлет Set-Alias создает псевдоним в текущем сеансе PowerShell. Параметр Name указывает имя псевдонима, list. Параметр Value указывает командлет, который запускает псевдоним.

Чтобы запустить псевдоним, введите list в командной строке PowerShell.

Пример 2. Переназначение существующего псевдонима другому командлету

Эта команда переназначает существующий псевдоним для запуска другого командлета.

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-ChildItem

PS> Set-Alias -Name list -Value Get-Location

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-Location

Командлет Get-Alias использует параметр Name для отображения псевдонима list. Псевдоним list связан с командлетом Get-ChildItem. При запуске псевдонима list отображаются элементы в текущем каталоге.

Командлет Set-Alias использует параметр Name для указания псевдонима list. Параметр Value связывает псевдоним с командлетом Get-Location.

Командлет Get-Alias использует параметр Name для отображения псевдонима list. Псевдоним list связан с командлетом Get-Location. При запуске псевдонима list отображается местоположение текущего каталога.

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

Эта команда создает псевдоним, доступный только для чтения. Параметр «только для чтения» предотвращает непреднамеренные изменения псевдонима. Чтобы изменить или удалить псевдоним, доступный только для чтения, используйте параметр Force.

Set-Alias -Name loc -Value Get-Location -Option ReadOnly -PassThru |
    Format-List -Property *

DisplayName         : loc -> Get-Location
Definition          : Get-Location
Options             : ReadOnly
Description         :
Name                : loc
CommandType         : Alias

$Parameters = @{
    Name        =  'loc'
    Value       =  (Get-Location)
    Option      =  'ReadOnly'
    Description =  'Displays the current directory'
    Force       = $true
    PassThru    = $true
}
Set-Alias @Parameters | Format-List -Property *

DisplayName         : loc -> Get-Location
Definition          : Get-Location
Options             : ReadOnly
Description         : Displays the current directory
Name                : loc
CommandType         : Alias

Командлет Set-Alias создает псевдоним в текущем сеансе PowerShell. Параметр Name указывает имя псевдонима, loc. Параметр Value указывает командлет Get-Location, который запускает псевдоним. Параметр Option указывает значение ReadOnly. Параметр PassThru представляет объект-псевдоним и отправляет объект по конвейеру в командлет Format-List. Format-List использует параметр Property со звездочкой (*), чтобы отображалось каждое свойство. В примере вывода показан частичный список этих свойств.

Псевдоним loc изменен добавлением двух параметров. Описание добавляет текст, поясняющий назначение псевдонима. Параметр Force необходим, поскольку псевдоним loc доступен только для чтения. Если параметр Force не используется, изменение не удастся.

Пример 4. Создайте псевдоним для исполняемого файла.

В этом примере создается псевдоним исполняемого файла на локальном компьютере.

PS> Set-Alias -Name np -Value C:\Windows\notepad.exe

PS> Get-Alias -Name np

CommandType     Name
-----------     ----
Alias           np -> notepad.exe

Командлет Set-Alias создает псевдоним в текущем сеансе PowerShell. Параметр Name указывает имя псевдонима, np. Параметр Значение указывает путь и имя приложения C:\Windows\notepad.exe. Командлет Get-Alias использует параметр Name, чтобы показать, что псевдоним np связан с notepad.exe.

Чтобы запустить псевдоним, введите np в командной строке PowerShell, чтобы открыть notepad.exe.

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

В этом примере показано, как назначить псевдоним команде с параметрами.

Вы можете создать псевдоним для командлета, например Set-Location. Вы не можете создать псевдоним для команды с параметрами и значениями, например Set-Location -Path C:\Windows\System32. Чтобы создать псевдоним для команды, создайте функцию, включающую эту команду, а затем создайте псевдоним для этой функции. Дополнительные сведения см. в разделе about_Functions.

Function CD32 {Set-Location -Path C:\Windows\System32}

Set-Alias -Name Go -Value CD32

Создается функция с именем CD32. Функция использует командлет Set-Location с параметром Path для указания каталога C:\Windows\System32.

Командлет Set-Alias создает псевдоним функции в текущем сеансе PowerShell. Параметр Name указывает имя псевдонима: Go. Параметр Value указывает имя функции, CD32.

Чтобы запустить псевдоним, введите Go в командной строке PowerShell. Функция CD32 запускается и переходит в каталог C:\Windows\System32.

Пример 6. Обновление параметров существующего псевдонима

В этом примере показано, как назначить несколько параметров с помощью параметра Option.

Продолжая предыдущий пример, установите псевдоним Go как ReadOnly и Private.

Set-Alias -Name Go -Option ReadOnly, Private

Псевдоним Go уже должен существовать. После выполнения команды псевдоним нельзя изменить без использования параметра Force, он доступен только в текущей области.

Параметры

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип :: SwitchParameter
Псевдонимы:: cf
Позиция:: Именованный
Значение по умолчанию:: False
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Description

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

Тип :: String
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Force

Используйте параметр Force, чтобы изменить или удалить псевдоним, для которого для параметра Option установлено значение ReadOnly.

Параметр Force не может изменить или удалить псевдоним, если для параметра Option установлено значение Constant.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: False
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Name

Указывает имя нового псевдонима. Имя псевдонима может содержать буквенно-цифровые символы и дефисы. Имена псевдонимов не могут быть числовыми, например 123.

Тип :: String
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

-Option

Устанавливает значение свойства Option псевдонима. Такие значения, как ReadOnly и Constant, защищают псевдоним от непреднамеренных изменений. Чтобы просмотреть свойство Option всех псевдонимов в сеансе, введите Get-Alias | Формат-Таблица-Имя свойства, Параметры-Авторазмер.

Допустимые значения этого параметра следующие:

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

Unspecified

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

Тип :: ScopedItemOptions
Принятые значения:: AllScope, константа, нет, частная, только для чтения, не указано
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-PassThru

Возвращает объект, представляющий псевдоним. Используйте командлет форматирования, например Format-List, чтобы отобразить объект. По умолчанию Set-Alias не генерирует никаких выходных данных.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Scope

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

Приемлемые значения следующие:

Global

Local

Private

Numbered scopes

Script

Тип :: String
Принятые значения:: Глобальная, локальная, частная, нумерованная область действия, сценарий
Позиция:: Именованный
Значение по умолчанию:: Местный
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Value

Указывает имя командлета или команды, которую запускает псевдоним. Параметр Значение — это свойство Определение псевдонима.

Тип :: String
Позиция:: 1
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

-WhatIf

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

Тип :: SwitchParameter
Псевдонимы:: wi
Позиция:: Именованный
Значение по умолчанию:: False
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

Входы

Нет

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

Выходы

Нет

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

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

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

Примечания

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

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

PowerShell включает встроенные псевдонимы, доступные в каждом сеансе PowerShell. Командлет Get-Alias отображает псевдонимы, доступные в сеансе PowerShell.

Чтобы создать псевдоним, используйте командлеты Set-Alias или New-Alias. В PowerShell 6 для удаления псевдонима используйте командлет Remove-Alias. Remove-Item принимается для обратной совместимости, например, для сценариев, созданных с помощью предыдущих версий PowerShell. Используйте такую команду, как Remove-Item -Path Alias:aliasname.

Чтобы создать псевдоним, доступный в каждом сеансе PowerShell, добавьте его в свой профиль PowerShell. Дополнительные сведения см. в разделе about_Profiles.

Псевдоним можно сохранить и повторно использовать в другом сеансе PowerShell, выполнив экспорт и импорт. Чтобы сохранить псевдоним в файл, используйте Export-Alias. Чтобы добавить сохраненный псевдоним в новый сеанс PowerShell, используйте Import-Alias.