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 Параметр Value указывает путь и имя 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-LocationPath для указания каталога 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 — это свойство определения псевдонима.

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. Чтобы удалить псевдоним, используйте Remove-Alias командлет в PowerShell 6. Remove-Item принимается для обратной совместимости, например для сценариев, созданных с предыдущими версиями PowerShell. Используйте команду, например Remove-Item -Path Alias:aliasname.

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

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

Set-Alias

Синтаксис

Описание

Примеры

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

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

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

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

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

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

Параметры

-Confirm

-Description

-Force

-Name

-Option

-PassThru

-Scope

-Value

-WhatIf

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

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

Примечания

Обратная связь

Дополнительные ресурсы

Set-Alias

Синтаксис

Описание

Примеры

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

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

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

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

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

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

Параметры

-Confirm

-Description

-Force

-Name

-Option

-PassThru

-Scope

-Value

-WhatIf

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

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

Примечания

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

Обратная связь

Дополнительные ресурсы