Set-Alias

参考

模块:: Microsoft.PowerShell.Utility

在当前 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 是 Set-Alias cmdlet 的别名。有关详细信息，请参阅 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 参数。

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 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 的函数。该函数使用具有 Path 参数的 Set-Location 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 之前，提示你进行确认。

类型:	SwitchParameter
别名:	cf
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

-Description

指定别名的说明。可以键入任何字符串。如果说明包含空格，请将它括在单引号中。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Force

使用 Force 参数更改或删除 Option 参数设置为 ReadOnly的别名。

Force 参数无法更改或删除别名，Option 参数设置为常量。

类型:	SwitchParameter
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

-Name

指定新别名的名称。别名可以包含字母数字字符和连字符。别名不能为数字，例如 123。

类型:	String
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Option

设置别名的选项属性值。 ReadOnly 和 Constant 等值可防止别名意外更改。若要查看会话中所有别名的 Option 属性，请键入 Get-Alias | Format-Table -Property Name, Options -Autosize。

此参数的可接受值如下所示：

AllScope - 别名将复制到创建的任何新作用域。
Constant - 无法更改或删除。
None - 不设置任何选项，并且是默认值。
Private - 别名仅在当前范围内可用。
ReadOnly - 除非使用 Force 参数，否则无法更改或删除。
Unspecified

这些值定义为基于标志的枚举。可以使用此参数将多个值组合在一起以设置多个标志。可以将值作为值数组或这些值的逗号分隔字符串传递给 Option 参数。该 cmdlet 使用二进制 OR 操作合并值。将值作为数组传递是最简单的选项，还允许对值使用 Tab 补全。

类型:	ScopedItemOptions
接受的值:	AllScope, Constant, None, Private, ReadOnly, Unspecified
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PassThru

返回一个表示别名的对象。使用格式 cmdlet（如 Format-List）显示对象。默认情况下，Set-Alias 不会生成任何输出。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Scope

指定此别名有效的范围。默认值为本地。有关详细信息，请参阅 about_Scopes。

可接受的值如下所示：

Global
Local
Private
Numbered scopes
Script

类型:	String
接受的值:	Global, Local, Private, Numbered scopes, Script
Position:	Named
默认值:	Local
必需:	False
接受管道输入:	False
接受通配符:	False

-Value

指定别名运行的 cmdlet 或命令的名称。 Value 参数是别名的定义属性。

类型:	String
Position:	1
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。该 cmdlet 未运行。

类型:	SwitchParameter
别名:	wi
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

输入

None

不能通过管道将对象传递给此 cmdlet。

输出

None

默认情况下，此 cmdlet 不返回任何输出。

AliasInfo

使用 PassThru 参数时，此 cmdlet 返回表示别名的 AliasInfo 对象。

备注

PowerShell 包含以下 Set-Alias别名：

所有平台：
- sal

PowerShell 包括每个 PowerShell 会话中可用的内置别名。 Get-Alias cmdlet 显示 PowerShell 会话中可用的别名。

若要创建别名，请使用 cmdlet Set-Alias 或 New-Alias。在 PowerShell 6 中，若要删除别名，请使用 Remove-Alias cmdlet。对于使用早期版本的 PowerShell 创建的脚本，接受 Remove-Item 以实现向后兼容性。使用 Remove-Item -Path Alias:aliasname等命令。

若要创建每个 PowerShell 会话中可用的别名，请将其添加到 PowerShell 配置文件。有关详细信息，请参阅 about_Profiles。

可以通过执行导出和导入，在另一个 PowerShell 会话中保存和重复使用别名。若要将别名保存到文件，请使用 Export-Alias。若要将保存的别名添加到新的 PowerShell 会话，请使用 Import-Alias。

通过