New-Alias
建立新的別名。
語法
Default (預設值)
New-Alias
[-Name] <String>
[-Value] <String>
[-Description <String>]
[-Option <ScopedItemOptions>]
[-PassThru]
[-Scope <String>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
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 |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | cf |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Description
指定別名的描述。 您可以輸入任何字串。 如果描述包含空格,請以引號括住它。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Force
指出如果名為 的別名已經存在,Cmdlet 的作用就像 Set-Alias。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
指定新的別名。 您可以在別名中使用任何英數位元,但第一個字元不能是數位。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 0 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | 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 |
| 預設值: | [System.Management.Automation.ScopedItemOptions]::None |
| 接受的值: | None, ReadOnly, Constant, Private, AllScope, Unspecified |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PassThru
返回一個物件,代表您正在處理的項目。 根據預設,此 Cmdlet 不會產生任何輸出。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Scope
指定新別名的範圍。 此參數可接受的值為:
GlobalLocalScript- 相對於目前範圍的數位(0 到範圍的數目,其中
0是目前的範圍,1是其父系)。
Local 是預設值。 如需詳細資訊,請參閱 about_Scopes。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Value
指定別名的 Cmdlet 或命令項目名稱。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。 指令未執行。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 無線 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。
輸入
None
您不能將物件透過管道傳送到此 Cmdlet。
輸出
None
根據預設,此 Cmdlet 不會傳回任何輸出。
AliasInfo
當您使用 PassThru 參數時,這個 Cmdlet 會傳回代表新別名的 AliasInfo 物件。
備註
PowerShell 包含下列 New-Alias的別名:
所有平臺:
nal
若要建立新的別名,請使用
Set-Alias或New-Alias。 若要變更別名,請使用Set-Alias。 若要刪除別名,請使用Remove-Alias。