Set-Alias
为当前 PowerShell 会话中的 cmdlet 或其他命令创建或更改别名。
语法
Set-Alias
[-Name] <string>
[-Value] <string>
[-Description <string>]
[-Option <ScopedItemOptions>]
[-PassThru]
[-Scope <string>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
该 Set-Alias
cmdlet 为 cmdlet 或命令(例如函数、脚本、文件或其他可执行文件)创建或更改别名。 别名是引用 cmdlet 或命令的备用名称。
例如, sal
是 cmdlet 的 Set-Alias
别名。 有关详细信息,请参阅 about_Aliases。
cmdlet 可以有多个别名,但别名只能与一个 cmdlet 相关联。 可用于 Set-Alias
将现有别名重新分配给另一个 cmdlet,或更改别名的属性,例如说明。
创建或更改的 Set-Alias
别名不是永久性的,仅在当前 PowerShell 会话期间可用。 关闭 PowerShell 会话后,将删除别名。
示例
示例 1:创建 cmdlet 的别名
此命令在当前 PowerShell 会话中创建 cmdlet 的别名。
PS> Set-Alias -Name list -Value Get-ChildItem
PS> Get-Alias -Name list
CommandType Name
----------- ----
Alias list -> Get-ChildItem
该 Set-Alias
cmdlet 在当前 PowerShell 会话中创建别名。 Name 参数指定别名的名称。 list
Value 参数指定别名运行的 cmdlet。
若要运行别名,请在 PowerShell 命令行上键入 list
。
示例 2:将现有别名重新分配给其他 cmdlet
此命令重新分配现有别名以运行不同的 cmdlet。
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
cmdlet 使用 Name 参数显示 list
别名。 别名 list
与 Get-ChildItem
cmdlet 相关联。 运行 list
别名时,将显示当前目录中的项。
该 Set-Alias
cmdlet 使用 Name 参数指定 list
别名。 Value 参数将别名关联到 Get-Location
cmdlet。
该 Get-Alias
cmdlet 使用 Name 参数显示 list
别名。 别名 list
与 Get-Location
cmdlet 相关联。 list
运行别名时,将显示当前目录的位置。
示例 3:创建和更改只读别名
此命令创建只读别名。 只读选项可防止对别名进行意外更改。 若要更改或删除只读别名,请使用 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
cmdlet 在当前 PowerShell 会话中创建别名。 Name 参数指定别名的名称。 loc
Value 参数指定Get-Location
别名运行的 cmdlet。 Option 参数指定 ReadOnly 值。 PassThru 参数表示别名对象,并将对象向下Format-List
发送到 cmdlet。 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
cmdlet 在当前 PowerShell 会话中创建别名。 Name 参数指定别名的名称。 np
Value 参数指定路径和应用程序名称C:\Windows\notepad.exe。 该 Get-Alias
cmdlet 使用 Name 参数显示别名 np
与 notepad.exe相关联。
若要运行别名,请在 PowerShell 命令行上键入 np
以打开 notepad.exe。
示例 5:为具有参数的命令创建别名
此示例演示如何将别名分配给具有参数的命令。
可以为 cmdlet 创建别名,例如 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 参数的 cmdlet 来指定目录。 C:\Windows\System32
该 Set-Alias
cmdlet 在当前 PowerShell 会话中创建函数的别名。 Name 参数指定别名的名称。 Go
Value 参数指定函数的名称。 CD32
若要运行别名,请在 PowerShell 命令行上键入 Go
。 该 CD32
函数运行并更改目录 C:\Windows\System32
。
示例 6:现有别名的更新选项
此示例演示如何使用 Option 参数分配多个选项。
使用上面的示例,我们将别名Go
ReadOnly
设置为和 Private
。
Set-Alias -Name Go -Option ReadOnly, Private
Go
别名应已存在。 运行上述命令后,在不使用 Force 参数的情况下无法更改别名,并且只能在当前范围内使用。
参数
-Confirm
提示你在运行 cmdlet 之前进行确认。
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 参数。 cmdlet 将使用二进制 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
返回一个表示别名的对象。 使用格式 cmdlet,例如 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
指定别名运行的 cmdlet 或命令的名称。 Value 参数是别名的 Definition 属性。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
显示在此 cmdlet 运行的情况下将会发生什么。 此 cmdlet 未运行。
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 参数时, Set-Alias
生成表示别名的 System.Management.Automation.AliasInfo 对象。 否则, Set-Alias
不生成任何输出。
备注
PowerShell 包括每个 PowerShell 会话中可用的内置别名。 该 Get-Alias
cmdlet 显示 PowerShell 会话中可用的别名。
若要创建别名,请使用 cmdlet Set-Alias
或 New-Alias
. 在 PowerShell 6 中,若要删除别名,请使用 Remove-Alias
cmdlet。 Remove-Item
接受后向兼容性,例如使用早期版本的 PowerShell 创建的脚本。 使用诸如 . 之类的 Remove-Item -Path Alias:aliasname
命令。
若要创建每个 PowerShell 会话中可用的别名,请将其添加到 PowerShell 配置文件。 有关详细信息,请参阅 about_Profiles。
可以通过执行导出和导入,在另一个 PowerShell 会话中保存和重复使用别名。 若要将别名保存到文件,请使用 Export-Alias
。 若要将保存的别名添加到新的 PowerShell 会话,请使用 Import-Alias
。