New-Alias

参考

模块:: Microsoft.PowerShell.Utility

创建新的别名。

语法

New-Alias
   [-Name] <String>
   [-Value] <String>
   [-Description <String>]
   [-Option <ScopedItemOptions>]
   [-PassThru]
   [-Scope <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

New-Alias cmdlet 在当前 PowerShell 会话中创建新的别名。退出会话或关闭 PowerShell 后，不会保存使用 New-Alias 创建的别名。可以使用 Export-Alias cmdlet 将别名信息保存到文件中。稍后可以使用 Import-Alias 检索保存的别名信息。

示例

示例 1：为 cmdlet 创建别名

New-Alias -Name "List" Get-ChildItem

此命令创建一个名为 List 的别名来表示 Get-ChildItem cmdlet。

示例 2：为 cmdlet 创建只读别名

此命令创建一个名为 C 的别名来表示 Get-ChildItem cmdlet。它为别名创建“快速 gci 别名”的说明，并使它为只读。

New-Alias -Name "C" -Value Get-ChildItem -Description "Quick gci alias" -Option ReadOnly
Get-Alias -Name "C" | Format-List *

HelpUri             : https://go.microsoft.com/fwlink/?LinkID=2096492
ResolvedCommandName : Get-ChildItem
DisplayName         : C -> Get-ChildItem
ReferencedCommand   : Get-ChildItem
ResolvedCommand     : Get-ChildItem
Definition          : Get-ChildItem
Options             : ReadOnly
Description         : Quick gci alias
OutputType          : {System.IO.FileInfo, System.IO.DirectoryInfo}
Name                : C
CommandType         : Alias
Source              :
Version             :
Visibility          : Public
ModuleName          :
Module              :
RemotingCapability  : PowerShell
Parameters          : {[Path, System.Management.Automation.ParameterMetadata], [LiteralPath,
                      System.Management.Automation.ParameterMetadata], [Filter,
                      System.Management.Automation.ParameterMetadata], [Include,
                      System.Management.Automation.ParameterMetadata]…}

传递给 Get-Alias 的 Format-List 命令显示有关新别名的所有信息。

示例 3：为具有参数的命令创建别名

function Set-ParentDirectory {Set-Location -Path ..}
New-Alias -Name .. -Value Set-ParentDirectory

第一个命令创建函数 Set-ParentDirectory，该函数使用 Set-Location 将工作位置设置为父目录。第二个命令使用 New-Alias 创建 .. 的别名来调用 Set-ParentDirectory 函数。由于 Value 参数需要 cmdlet、函数或可执行值，必须创建自定义函数才能创建使用参数的别名。运行别名 .. 将当前位置更改为父目录。

参数

-Confirm

在运行 cmdlet 之前，提示你进行确认。

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

-Description

指定别名的说明。可以键入任何字符串。如果说明包含空格，请用引号将其括起来。

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

-Force

指示 cmdlet 的行为类似于 Set-Alias（如果已命名的别名已存在）。

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

-Name

指定新的别名。可以在别名中使用任何字母数字字符，但第一个字符不能是数字。

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

-Option

指定别名的 Options 属性的值。有效值为：

None：别名没有约束（默认值）
ReadOnly：可以使用 Force 参数来删除别名，但不能更改别名
Constant：无法删除或更改别名
Private：别名仅在当前范围内可用
AllScope：别名将复制到创建的任何新作用域
Unspecified：未指定选项

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

若要查看会话中所有别名的 Options 属性，请键入 Get-Alias | Format-Table -Property Name, Options -AutoSize。

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

-PassThru

返回一个对象，该对象表示正在使用的项。默认情况下，此 cmdlet 不生成任何输出。

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

-Scope

指定新别名的范围。此参数的可接受值为：

Global
Local
Script
一个相对于当前范围的数字（0 到范围的数目，其中 0 是当前范围，1 是它的父范围）。

Local 为默认值。有关详细信息，请参阅 about_Scopes。

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

-Value

指定要别名的 cmdlet 或命令元素的名称。

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

-WhatIf

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

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

输入

None

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

输出