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

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 .

PS> 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

PS> Set-Alias -Name loc -Value Get-Location -Option ReadOnly -Description 'Displays the current directory' -Force -PassThru | 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.

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

PS> 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.

Параметры

-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 Псевдоним копируется во все новые области, которые создаются.
  • Постоянной Невозможно изменить или удалить.
  • Ни один Не задает параметров и является значением по умолчанию.
  • Частная Псевдоним доступен только в текущем область.
  • Readonly Невозможно изменить или удалить, если не используется параметр Force .
  • Unspecified
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.

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

  • Глобальный
  • Local
  • Private
  • Нумерованные области
  • Скрипт
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

Set-Alias не принимает входные данные из конвейера.

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

None or System.Management.Automation.AliasInfo

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

Примечания

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

Чтобы создать псевдоним, используйте Set-Alias или New-Alias. Чтобы удалить псевдоним, используйте Remove-Item командлет . Например, Remove-Item -Path Alias:aliasname.

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

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