Set-Alias
在目前的 PowerShell 會話中,建立或變更 Cmdlet 或其他命令的別名。
Syntax
Set-Alias
[-Name] <string>
[-Value] <string>
[-Description <string>]
[-Option <ScopedItemOptions>]
[-PassThru]
[-Scope <string>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cmdlet Set-Alias
會建立或變更 Cmdlet 或命令的別名,例如函式、腳本、檔案或其他可執行檔。 別名是參考 Cmdlet 或命令的替代名稱。
例如, sal
是 Cmdlet 的 Set-Alias
別名。 如需詳細資訊,請參閱 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
Cmdlet 會在 Set-Alias
目前的 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
Cmdlet 會 Get-Alias
使用 Name 參數來顯示 list
別名。 別名 list
與 Get-ChildItem
Cmdlet 相關聯。 list
執行別名時,會顯示目前目錄中的專案。
Cmdlet 會 Set-Alias
使用 Name 參數來指定 list
別名。 Value 參數會將別名與 Get-Location
Cmdlet 產生關聯。
Cmdlet 會 Get-Alias
使用 Name 參數來顯示 list
別名。 別名 list
與 Get-Location
Cmdlet 相關聯。 list
執行別名時,會顯示目前目錄的位置。
範例 3:Create 並變更唯讀別名
此命令會建立唯讀別名。 唯讀選項可防止對別名進行非預期的變更。 若要變更或刪除唯讀別名,請使用 Force 參數。
PS> 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
PS> Set-Alias -Name loc -Value Get-Location -Option ReadOnly -Description 'Displays the current directory' -Force -PassThru | Format-List -Property *
DisplayName : loc -> Get-Location
Definition : Get-Location
Options : ReadOnly
Description : Displays the current directory
Name : loc
CommandType : Alias
Cmdlet 會在 Set-Alias
目前的 PowerShell 工作階段中建立別名。 Name 參數會指定別名的名稱 。 loc
Value 參數會Get-Location
指定別名執行的 Cmdlet。 Option 參數會指定 ReadOnly 值。 PassThru 參數代表別名物件,並將物件向下傳送至 Format-List
Cmdlet。 Format-List
會使用 Property 參數搭配星號 (*
) ,以便顯示所有屬性。 範例輸出會顯示這些屬性的部分清單。
別名 loc
會隨著新增兩個參數而變更。 描述 會新增文字來說明別名的目的。 需要 Force 參數,loc
因為別名是唯讀的。 如果未使用 Force 參數,變更就會失敗。
範例 4:Create 可執行文件的別名
此範例會在本機計算機上建立可執行文件的別名。
PS> Set-Alias -Name np -Value C:\Windows\notepad.exe
PS> Get-Alias -Name np
CommandType Name
----------- ----
Alias np -> notepad.exe
Cmdlet 會在 Set-Alias
目前的 PowerShell 工作階段中建立別名。 Name 參數會指定別名的名稱 。 np
Value 參數會指定C:\Windows\notepad.exe的路徑和應用程式名稱。 Cmdlet Get-Alias
會使用 Name 參數來顯示 np
別名與 notepad.exe相關聯。
若要執行別名,請在 PowerShell 命令列上輸入 np
,以開啟 notepad.exe。
範例 5:使用參數 Create 命令的別名
此範例示範如何使用參數將別名指派給命令。
您可以建立 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
函式。 函式會Set-Location
使用 Cmdlet 搭配 Path 參數來指定目錄 C:\Windows\System32
Cmdlet 會在 Set-Alias
目前的 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 前提示您確認。
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
使用 Force 參數來變更或刪除 將 Option 參數設定為 ReadOnly 的別名。
Force 參數無法變更或刪除將 Option 參數設定為 Constant 的別名。
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
指定新別名的名稱。 別名名稱可以包含英數位元和連字元。 別名名稱不能是數值,例如123。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Option
設定別名的 Option 屬性值。 和 之類的ReadOnly
Constant
值會保護別名,以防止非預期的變更。 若要檢視工作階段中所有別名的 Option 屬性,請輸入 Get-Alias | Format-Table -Property Name, Options -Autosize
。
此參數可接受的值如下所示:
AllScope
- 別名會複製到任何已建立的新範圍。Constant
- 無法變更或刪除。None
- 不設定任何選項,而且是預設值。Private
- 別名僅適用於目前的範圍。ReadOnly
- 除非使用 Force 參數,否則無法變更或刪除。Unspecified
這些值會定義為旗標型列舉。 您可以使用此參數將多個值結合在一起,以設定多個旗標。 這些值可以當做值的陣列或這些值的逗號分隔字串傳遞至 Option 參數。 Cmdlet 會使用二進位 OR 作業來合併值。 將值當做數位傳遞是最簡單的選項,也可讓您在值上使用 Tab 鍵自動完成。
Type: | ScopedItemOptions |
Accepted values: | AllScope, Constant, None, Private, ReadOnly, Unspecified |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
傳回代表別名的物件。 使用之類的 Format-List
格式 Cmdlet 來顯示物件。 根據預設, Set-Alias
不會產生任何輸出。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Scope
指定別名的有效範圍。 預設值為 Local。 如需詳細資訊,請參閱 about_Scopes。
可接受的值如下所示:
- 全球
- 本機
- 私人
- 編號範圍
- 指令碼
Type: | String |
Accepted values: | Global, Local, Private, Numbered scopes, Script |
Position: | Named |
Default value: | Local |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Value
指定別名執行之 Cmdlet 或命令的名稱。 Value 參數是別名的 Definition 屬性。
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
Set-Alias
不接受來自管線的輸入。
輸出
None or System.Management.Automation.AliasInfo
當您使用 PassThru 參數時, Set-Alias
會產生代表別名的 System.Management.Automation.AliasInfo 物件。 否則, Set-Alias
不會產生任何輸出。
備註
PowerShell 包含每個 PowerShell 工作階段中可用的內建別名。 Cmdlet Get-Alias
會顯示 PowerShell 工作階段中可用的別名。
若要建立別名,請使用 Cmdlet Set-Alias
或 New-Alias
。 在 PowerShell 6 中,若要刪除別名,請使用 Remove-Alias
Cmdlet。 Remove-Item
接受回溯相容性,例如使用舊版 PowerShell 建立的腳本。 使用 命令,例如 Remove-Item -Path Alias:aliasname
。
若要建立每個 PowerShell 工作階段中可用的別名,請將它新增至您的 PowerShell 配置檔。 如需詳細資訊,請參閱 about_Profiles。
您可以執行導出和匯入,在另一個 PowerShell 工作階段中儲存和重複使用別名。 若要將別名儲存至檔案,請使用 Export-Alias
。 若要將已儲存的別名新增至新的 PowerShell 工作階段,請使用 Import-Alias
。