Export-Alias
將目前已定義別名的相關資訊匯出至檔案。
Syntax
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
Cmdlet 會將 Export-Alias 目前會話中的別名導出至檔案。
如果輸出檔案不存在，此 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 檔案。 它會使用 As 參數搭配 Script 值來產生包含每個別名之 Set-Alias 命令的檔案。
第二個命令將 Alias.ps1 檔案中的別名加入 CurrentUser-CurrentHost 設定檔。
配置檔的路徑會儲存在變數中 $Profile 。
此命令會 Get-Content 使用 Cmdlet 從 Alias.ps1 檔案取得別名，以及 Add-Content Cmdlet，以將它們新增至配置檔。
如需詳細資訊，請參閱 about_Profiles。
第三和第四個命令會將 Alias.ps1 檔案中的別名新增至 Server01 計算機上的遠端會話。
第三個命令會 New-PSSession 使用 Cmdlet 來建立會話。
第四個命令會使用 Cmdlet 的 Invoke-CommandFilePath 參數，在新會話中執行 Alias.ps1 檔案。
參數
-Append
表示這個 Cmdlet 會將輸出附加至指定的檔案，而不是覆寫該檔案的現有內容。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-As
指定輸出格式。 預設值為 CSV。 此參數可接受的值為：
- CSV。 以逗號分隔的值 (CSV) 格式。
- 指令碼：
為每個導出的別名建立
Set-Alias命令。 如果您以 .ps1 副檔名命名輸出檔案，可以指令碼的方式執行它將別名加入任何工作階段。
| Type: | ExportAliasFormat |
| Accepted values: | Csv, Script |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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
強制執行命令而不要求使用者確認。
覆寫輸出檔案，即使檔案設定了唯讀屬性亦同。
根據預設， Export-Alias 除非已設定只讀或隱藏屬性，或在 命令中使用 NoClobber 參數，否則會覆寫沒有警告的檔案。
當兩者都用於命令時， NoClobber 參數的優先順序高於 Force 參數。
Force 參數無法強制Export-Alias使用隱藏屬性覆寫檔案。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LiteralPath
指定輸出檔案的路徑。 與 Path 不同，LiteralPath 參數值將完全依照其輸入值來使用。 沒有字元會被視為萬用字元。 如果路徑包含逸出字元，請將它括在單引號中。 單引號會告訴PowerShell不要將任何字元解譯為逸出序列。
| Type: | String |
| Aliases: | PSPath, LP |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
指定要匯出之別名的名稱數位。 允許使用萬用字元。
根據預設，導出 Export-Alias 會話或範圍中的所有別名。
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-NoClobber
表示此 Cmdlet 會防止 Export-Alias 覆寫任何檔案，即使 Force 參數是在 命令中使用也一樣。
如果省略 NoClobber 參數， Export-Alias 除非在檔案上設定只讀屬性，否則將會覆寫現有的檔案而不發出警告。
NoClobber 優先於 Force 參數，其允許 Export-Alias 以唯讀屬性覆寫檔案。
NoClobber 不會防止 Append 參數將內容新增至現有的檔案。
| Type: | SwitchParameter |
| Aliases: | NoOverwrite |
| Position: | Named |
| Default value: | 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 |
-Path
指定輸出檔案的路徑。 允許使用萬用字元，但是產生的路徑值必須解析成單一檔案名稱。
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Scope
指定要匯出別名的範圍。 此參數可接受的值為：
- 全球
- 本機
- 指令碼
- 相對於目前範圍的數位 (0 到範圍數目，其中 0 是目前範圍，1 是其父)
預設值為 Local。 如需詳細資訊，請參閱 about_Scopes。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 參數時， Export-Alias 會傳回代表別名的 System.Management.Automation.AliasInfo 物件。
否則，此 Cmdlet 不會產生任何輸出。
備註
- 您只能匯出別名 (Export-Aliases) 至檔案。