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
个名为表示 cmdlet 的 Get-ChildItem
别名。 它为该别名创建了说明、快速 wmi 别名,并使其只读。 该命令的最后一行用于 Get-Alias
获取新别名,并通过管道将其传递给Format-List以显示有关它的所有信息。
参数
-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
指示该 cmdlet 的行为类似于 Set-Alias
命名的别名是否已存在。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
指定新的别名。 可以在别名中使用任何字母数字字符,但第一个字符不能为数字。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Option
指定别名的 Options 属性的值。 有效值是:
None
:别名没有约束 (默认值)ReadOnly
:别名可以删除,但不能更改,除非使用 Force 参数Constant
:无法删除或更改别名Private
:别名仅在当前范围内可用AllScope
:别名将复制到创建的任何新作用域Unspecified
:未指定选项
这些值定义为基于标志的枚举。 可以将多个值组合在一起,以使用此参数设置多个标志。 这些值可以作为值数组或这些值的逗号分隔字符串传递给 Option 参数。 该 cmdlet 将使用二进制 OR 操作合并值。 将值作为数组传递是最简单的选项,还允许对值使用 Tab 完成。
若要查看会话中所有别名的 Options 属性,请键入 Get-Alias | Format-Table -Property Name, Options -AutoSize
。
Type: | ScopedItemOptions |
Accepted values: | None, ReadOnly, Constant, Private, AllScope, Unspecified |
Position: | Named |
Default value: | [System.Management.Automation.ScopedItemOptions]::None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
返回一个代表你所处理的项目的对象。 默认情况下,此 cmdlet 将不产生任何输出。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Scope
指定新别名的范围。 此参数的可接受值为:
Global
Local
Script
- 相对于当前范围的数字, (0 到范围的数量,其中
0
是当前范围,1
并且是其父) 。
Local
是默认值。 有关详细信息,请参阅 about_Scopes。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Value
指定作为别名的 cmdlet 或命令元素的名称。
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
不能通过管道将输入传递给此 cmdlet。
输出
None or System.Management.Automation.AliasInfo
使用 Passthru 参数时, New-Alias
生成表示新别名的 System.Management.Automation.AliasInfo 对象。 否则,此 cmdlet 将不生成任何输出。
备注
- 若要创建新的别名,请使用
Set-Alias
或New-Alias
。 若要更改别名,请使用Set-Alias
。 若要删除别名,请使用Remove-Item
。