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

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

Эта команда создает псевдоним только для чтения. Параметр только для чтения предотвращает непреднамеренные изменения псевдонима. Чтобы изменить или удалить псевдоним только для чтения, используйте параметр 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. Create псевдонима в исполняемый файл

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

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. Параметр Value указывает путь и имя C:\Windows\notepad.exeприложения . Командлет Get-Alias использует параметр Name , чтобы показать, что np псевдоним связан с notepad.exe.

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

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

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

Можно создать псевдоним для командлета, например 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

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

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

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

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

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

-Name

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

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

-Option

Задает значение свойства Option псевдонима. Такие значения, как ReadOnly и Constant , защищают псевдоним от непреднамеренных изменений. Чтобы просмотреть свойство Option всех псевдонимов в сеансе, введите Get-Alias | Format-Table -Property Name, Options -Autosize.

Ниже приведены допустимые значения для этого параметра.

• AllScope — псевдоним копируется во все новые области, которые создаются.
• Constant — Невозможно изменить или удалить.
• None — не задает параметров и является значением по умолчанию.
• Private— Псевдоним доступен только в текущем область.
• ReadOnly — Невозможно изменить или удалить, если не используется параметр Force .
• Unspecified

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

Type:	ScopedItemOptions
Accepted values:	AllScope, Constant, None, Private, ReadOnly, Unspecified
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

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

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

-Scope

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

Допустимые значения:

• Global
• Local
• Private
• Numbered scopes
• Script

Type:	String
Accepted values:	Global, Local, Private, Numbered scopes, Script
Position:	Named
Default value:	Local
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Value

Указывает имя командлета или команды, запускаемых псевдонимом. Параметр Value является свойством Definition псевдонима.

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 включает следующие псевдонимы для Set-Alias:

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

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

Связанные ссылки

• about_Aliases
• about_Functions
• about_Profiles
• about_Scopes
• Export-Alias
• Get-Alias
• Import-Alias
• New-Alias
• Remove-Alias
• Remove-Item