Set-Alias

模組:

Microsoft.PowerShell.Utility Module

在目前 PowerShell 會話中建立或更改 cmdlet 或其他指令的別名。

語法

Default (預設值)

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

Description

指令檔會 Set-Alias 為指令檔或指令（例如函式、腳本、檔案或其他可執行檔）建立或變更別名。 別名是一種替代名稱，指涉一個指令小程式或指令。 例如， sal 是 指令令的別名 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

Set-Alias該 cmdlet 會在目前的 PowerShell 會話中建立別名。 名稱參數指定別名名稱。 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

指令本使用Get-Alias名稱參數來顯示list別名。 該 list 別名與指令 Get-ChildItem 長程式（cmdlet）相關聯。 當 list 執行別名時，目前目錄中的項目會被顯示出來。

Set-Alias指令小程式使用 Name 參數來指定list別名。 Value 參數將別名Get-Location與 cmdlet 關聯。

指令本使用Get-Alias名稱參數來顯示list別名。 該 list 別名與指令 Get-Location 長程式（cmdlet）相關聯。 當 list 執行別名時，會顯示目前目錄的位置。

範例 3：建立並更改唯讀別名

此指令會建立一個唯讀別名。 唯讀選項可防止別名的意外變更。 若要更改或刪除唯讀別名，請使用 強制 參數。

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

$Parameters = @{
    Name        =  'loc'
    Value       =  (Get-Location)
    Option      =  'ReadOnly'
    Description =  'Displays the current directory'
    Force       = $true
    PassThru    = $true
}
Set-Alias @Parameters | Format-List -Property *

DisplayName         : loc -> Get-Location
Definition          : Get-Location
Options             : ReadOnly
Description         : Displays the current directory
Name                : loc
CommandType         : Alias

Set-Alias該 cmdlet 會在目前的 PowerShell 會話中建立別名。 名稱參數指定別名名稱。 loc Value 參數指定別名執行的 Get-Location cmdlet。 Option 參數指定 ReadOnly 值。 PassThru 參數代表別名物件，並將物件沿管線傳送至 Format-List cmdlet。 Format-List 使用 Property 參數並加上星號（*），使每個屬性都能顯示。 範例輸出展示了這些屬性的部分清單。

loc別名會加入兩個參數。 說明 中會新增文字說明該別名的用途。 力 參數是 必要的，因為別 loc 名是唯讀的。 如果沒有使用 力 場參數，變更就會失敗。

範例 4：建立可執行檔的別名

此範例會建立一個可執行檔案的別名，位於本地電腦上。

PS> Set-Alias -Name np -Value C:\Windows\notepad.exe

PS> Get-Alias -Name np

CommandType     Name
-----------     ----
Alias           np -> notepad.exe

Set-Alias該 cmdlet 會在目前的 PowerShell 會話中建立別名。 名稱參數指定別名名稱。 np Value參數指定路徑與應用程式名稱 C:\Windows\notepad.exe。 指令 Get-Alias 本使用 名稱 參數來表示 np 別名與 相關聯 notepad.exe。

要執行別名，請在 PowerShell 命令列notepad.exe輸入 np 。

範例 5：為帶有參數的指令建立別名

這個範例展示了如何為帶有參數的指令指派別名。

你可以為 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。

該 Set-Alias cmdlet 會在目前 PowerShell 工作階段中為函式建立別名。 名稱參數指定別名名稱。 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 之前，提示您進行確認。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False
別名:	參見

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Description

指定別名的描述。 你可以輸入任何字串。 如果描述包含空格，請用單引號包圍。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Force

使用 Force 參數來更改或刪除將 Option 參數設為 ReadOnly 的別名。

Force 參數無法更改或刪除 Option 參數設為常數的別名。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Name

指定一個新別名的名字。 別名名稱可以包含字母數字和連字號。 別名不能是數字，例如 123。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Option

設定別名的 選項 屬性值。 像是保護別名免於意外變更等值ReadOnlyConstant。 要查看會話中所有別名的 Option 屬性，請輸入 Get-Alias | Format-Table -Property Name, Options -AutoSize。

此參數可接受的值如下：

• AllScope - 別名會被複製到任何新建立的示波器上。
• Constant - 不能更改或刪除。
• None - 不設定任何選項，且為預設。
• Private - 別名僅在目前範圍內可用。
• ReadOnly - 除非使用 力場 參數，否則無法更改或刪除。
• Unspecified

這些值會定義為旗標型列舉。 您可以將多個值結合在一起，以使用此參數來設定多個旗標。 這些值可以以數值陣列的形式傳遞給 Option 參數，或以逗號分隔的數值串形式傳遞。 Cmdlet 會使用二進位 OR 作業來結合值。 將值以陣列的形式傳遞是最簡單的選擇，還可以讓您在使用 Tab 鍵時自動完成值。

參數屬性

類型:	ScopedItemOptions
預設值:	None
接受的值:	AllScope, Constant, None, Private, ReadOnly, Unspecified
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-PassThru

回傳一個代表別名的物件。 使用格式 Format-List cmdlet 來顯示物件。 根據預設，Set-Alias 不會產生任何輸出。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Scope

指定該別名有效的範圍。 預設值為 Local。 如需詳細資訊，請參閱 about_Scopes。

可接受的數值如下：

• Global
• Local
• Private
• Numbered scopes
• Script

參數屬性

類型:	String
預設值:	Local
接受的值:	Global, Local, Private, Numbered scopes, Script
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Value

指定別名所執行的指令碼或指令名稱。 Value 參數是別名的定義屬性。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 該 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 包含下列 Set-Alias的別名：

• 所有平臺：
  • sal

PowerShell 內建別名，這些別名可在每個 PowerShell 工作階段中使用。 該 Get-Alias cmdlet 顯示 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.

相關連結

• about_Aliases
• 關於函數 (about_Functions)
• 關於個人檔案
• 關於_Scopes
• Export-Alias
• Get-Alias
• Import-Alias
• 新別名 (New-Alias)
• 刪除別名 (Remove-Alias)
• 移除項目