Export-Alias
將目前已定義別名的相關信息導出至檔案。
語法
Export-Alias
[-Path] <String>
[[-Name] <String[]>]
[-PassThru]
[-As <ExportAliasFormat>]
[-Append]
[-Force]
[-NoClobber]
[-Description <String>]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Export-Alias
-LiteralPath <String>
[[-Name] <String[]>]
[-PassThru]
[-As <ExportAliasFormat>]
[-Append]
[-Force]
[-NoClobber]
[-Description <String>]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
Export-Alias Cmdlet 會將目前會話中的別名導出至檔案。
如果輸出檔案不存在，Cmdlet 將會建立它。
Export-Alias 可以在特定範圍或所有範圍中匯出別名，它可以以 CSV 格式產生數據，或以一系列可新增至會話或 PowerShell 配置檔的 Set-Alias 命令產生數據。
範例
範例 1：導出別名
Export-Alias -Path "alias.csv"此命令會將目前的別名資訊匯出至目前目錄中名為 Alias.csv 的檔案。
範例 2：除非匯出檔案已經存在，否則匯出別名
Export-Alias -Path "alias.csv" -NoClobber此命令會將目前會話中的別名導出至 Alias.csv 檔案。
由於已指定 NoClobber 參數，因此如果目前目錄中已有 Alias.csv 檔案，命令將會失敗。
範例 3：將別名附加至檔案
Export-Alias -Path "alias.csv" -Append -Description "Appended Aliases" -Force此命令會將目前會話中的別名附加至 Alias.csv 檔案。
命令會使用 Description 參數，將描述新增至檔案頂端的批注。
命令也會使用 Force 參數來覆寫任何現有的 Alias.csv 檔案，即使它們具有唯讀屬性也一樣。
範例 4：將別名導出為腳本
Export-Alias -Path "alias.ps1" -As Script
Add-Content -Path $Profile -Value (Get-Content alias.ps1)
$S = New-PSSession -ComputerName Server01
Invoke-Command -Session $S -FilePath .\alias.ps1此範例示範如何使用 Export-Alias 產生的腳本檔格式。
第一個命令會將會話中的別名導出至 Alias.ps1 檔案。 它會使用具有 Script 值的 As 參數來產生包含每個別名 Set-Alias 命令的檔案。
第二個命令會將 Alias.ps1 檔案中的別名新增至 CurrentUser-CurrentHost 配置檔。
配置檔的路徑會儲存在 $Profile 變數中。
命令會使用 Get-Content Cmdlet 從 Alias.ps1 檔案取得別名，以及從 Add-Content Cmdlet 將別名新增至配置檔。
如需詳細資訊，請參閱about_Profiles。
第三和第四個命令會將 Alias.ps1 檔案中的別名新增至 Server01 計算機上的遠端會話。
第三個命令會使用 New-PSSession Cmdlet 來建立會話。
第四個命令會使用 Invoke-Command Cmdlet 的 FilePath 參數，在新會話中執行 Alias.ps1 檔案。
參數
-Append
指出這個 Cmdlet 會將輸出附加至指定的檔案，而不是覆寫該檔案的現有內容。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | False |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-As
指定輸出格式。 CSV 是預設值。
有效值為：
- CSV：逗號分隔值 （CSV） 格式。
- 腳本：為每個導出的別名建立 Set-Alias 命令。 如果您使用 .ps1 擴展名來命名輸出檔案，您可以將它當作腳本執行，以將別名新增至任何會話。
| 類型: | ExportAliasFormat |
| 接受的值: | Csv, Script |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Confirm
在執行 Cmdlet 之前，提示您進行確認。
| 類型: | SwitchParameter |
| 別名: | cf |
| Position: | Named |
| 預設值: | False |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Description
指定匯出檔案的描述。 描述會顯示為檔案頂端的批註，並遵循標頭資訊。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Force
強制命令執行，而不要求使用者確認。
覆寫輸出檔案，即使檔案上已設定只讀屬性也一樣。
根據預設，除非已設定只讀或隱藏屬性，否則 Export-Alias 會覆寫沒有警告的檔案，否則命令中會使用 NoClobber 參數。
當命令中使用兩者時，NoClobber 參數的優先順序高於 Force 參數。
Force 參數無法強制 Export-Alias 以隱藏屬性覆寫檔案。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-LiteralPath
指定輸出檔案的路徑。 不同於 Path，LiteralPath 參數的值會與輸入時完全相同。 不會將任何字元解譯為通配符。 如果路徑包含逸出字元，請以單引弧括住它。 單引號會告知PowerShell不要將任何字元解譯為逸出序列。
| 類型: | String |
| 別名: | PSPath |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-Name
指定要匯出之別名的陣列名稱。 允許通配符。
根據預設，Export-Alias 匯出會話或範圍中的所有別名。
| 類型: | String[] |
| Position: | 1 |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | True |
-NoClobber
表示此 Cmdlet 會防止 Export-Alias 覆寫任何檔案，即使命令中使用 Force 參數也一樣。
如果省略 NoClobber 參數，除非檔案上設定只讀屬性，否則 Export-Alias 會覆寫現有的檔案，而不會發出警告。
NoClobber 不會防止 Append 參數將內容新增至現有檔案。
| 類型: | SwitchParameter |
| 別名: | NoOverwrite |
| Position: | Named |
| 預設值: | False |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-PassThru
會傳回 物件，代表您正在使用的專案。 根據預設，此 Cmdlet 不會產生任何輸出。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Path
指定輸出檔案的路徑。 允許通配符，但產生的路徑值必須解析為單一檔名。
| 類型: | String |
| Position: | 0 |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | False |
| 接受萬用字元: | True |
-Scope
指定應該匯出別名的範圍。 此參數可接受的值為：
- 全球
- 當地
- 腳本
- 相對於目前範圍的數位（0 到範圍數目，其中0是目前範圍，1是其父系）
預設值為Local。 如需詳細資訊，請參閱 about_Scopes。
| 類型: | String |
| Position: | Named |
| 預設值: | Local |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。
| 類型: | SwitchParameter |
| 別名: | wi |
| Position: | Named |
| 預設值: | False |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
輸入
None.
您無法使用管線將物件傳送至此 Cmdlet。
輸出
None or System.Management.Automation.AliasInfo
當您使用 Passthru 參數時，Export-Alias 會傳回代表別名的 System.Management.Automation.AliasInfo 物件。
否則，此 Cmdlet 不會產生任何輸出。
備註
- 您只能 Export-Aliases 檔案。