New-Alias

创建新的别名。

语法

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 创建只读别名

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

此命令创建一个名为 C 的别名来表示 Get-ChildItem cmdlet。 它为别名创建说明(quick gci alias)并使其只读。 该命令的最后一行使用 Get-Alias 来获取新的别名,并通过管道将其传递给 Format-List 以显示有关它的所有信息。

参数

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

输出

None

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

AliasInfo

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

备注

PowerShell 包含以下 New-Alias别名:

  • 所有平台:

    • nal
  • 若要创建新的别名,请使用 Set-AliasNew-Alias。 若要更改别名,请使用 Set-Alias。 若要删除别名,请使用 Remove-Alias