將目前已定義的別名相關資訊匯出至檔案。

語法

Export-Alias [-Path] <string> [[-Name] <string[]>] [-Append] [-As {<Csv> | <Script>}] [-Description <string>] [-Force] [-NoClobber] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

描述

Export-Alias Cmdlet 會將目前工作階段中的別名匯出到檔案。如果輸出檔不存在，Cmdlet 將會建立它。

Export-Alias 能夠針對特定範圍或所有範圍中的別名進行匯出，也能夠以 CSV 格式或是以一連串可加到工作階段或 Windows PowerShell 設定檔的 Set-Alias 命令形式來產生資料。

參數

-Append

將輸出附加到指定的檔案，而非覆寫該檔案現有的內容。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-As <ExportAliasFormat>

決定輸出格式。預設為 CSV。

有效的值包括：

-- CSV：逗號分隔值 (CSV) 格式。

-- Script: 建立每個匯出的別名的 Set-Alias 命令。如果以 .ps1 副檔名來命名輸出檔，就能將它執行成指令碼，以便將別名新增到任何工作階段。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-Description <string>

在匯出檔中新增描述。描述會以註解的形式出現在檔案頂端，位於標頭資訊後面。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-Force

覆寫輸出檔，即使其中已設定唯讀屬性。

除非檔案上已設定唯讀或隱藏屬性或是命令中已使用 NoClobber 參數，否則 Export-Alias 預設會毫無預警地覆寫檔案。同時使用 NoClobber 參數與 Force 參數時，前者的優先順序高於後者。

Force 參數無法強制 Export-Alias 覆寫有隱藏屬性的檔案。

必要?

false

位置?

named

預設值

Does not overwrite read-only files.

接受管線輸入?

false

接受萬用字元?

false

-Name <string[]>

指定要匯出的別名名稱。允許使用萬用字元。

根據預設，Export-Alias 會將工作階段或範圍中的所有別名都匯出。

必要?

false

位置?

2

預設值

Export all aliases

接受管線輸入?

true (ByPropertyName)

接受萬用字元?

false

-NoClobber

防止 Export-Alias 覆寫任何檔案，即使命令中已使用 Force 參數亦然。

如果省略 NoClobber 參數，則除非現有檔案上已設定唯讀屬性，否則 Export-Alias 會毫無預警地覆寫該檔案。NoClobber 的優先順序高於 Force 參數，後者允許 Export-Alias 覆寫有唯讀屬性的檔案。

NoClobber 不能防止 Append 參數將內容加入至現有檔案。

必要?

false

位置?

named

預設值

Overwrites read-write files.

接受管線輸入?

false

接受萬用字元?

false

-PassThru

傳回代表已匯入之別名的物件。根據預設，此 Cmdlet 不會產生任何輸出。

必要?

false

位置?

named

預設值

No output

接受管線輸入?

false

接受萬用字元?

false

-路徑 <string>

指定輸出檔的路徑。允許使用萬用字元，但產生的路徑值必須解析成單一檔案名稱。此參數為必要項。

必要?

true

位置?

1

預設值

無

接受管線輸入?

false

接受萬用字元?

false

-Scope <string>

指定匯出的別名所隸屬的範圍。

有效的值包括 "Global"、"Local"、"Script" 或相對於目前範圍的數字 (從 0 到範圍總數，其中 0 代表目前範圍，1 代表其父範圍)。預設值為 "Local"。如需詳細資訊，請參閱 about_Scopes。

必要?

false

位置?

named

預設值

Local

接受管線輸入?

false

接受萬用字元?

false

-Confirm

在執行命令前先提示確認。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-WhatIf

說明執行命令時將會發生何種情況，但不會實際執行命令。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

<CommonParameters>

這個 Cmdlet 支援一般參數：-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。如需詳細資訊，請參閱 about_Commonparameters.

輸入和輸出

輸入型別是可經由管道輸出至 Cmdlet 的物件型別。傳回型別則是 Cmdlet 所傳回的物件型別。

輸入

無。

您無法經由管道將物件輸出至這個 Cmdlet。

輸出

None 或 System.Management.Automation.AliasInfo

當您使用 Passthru 參數時，Export-Alias 會傳回代表別名的 System.Management.Automation.AliasInfo 物件，否則，這個 Cmdlet 不會產生任何輸出。

附註

您只能將別名匯出 (Export-Alias) 到檔案。

範例 1

C:\PS>export-alias -path alias.csv

描述
-----------
這個命令會將目前別名資訊匯出到目前目錄中名為 Alias.csv 的檔案。

範例 2

C:\PS>export-alias -path alias.csv -noclobber

描述
-----------
這個命令會將目前工作階段中的別名匯出到 Alias.csv 檔案。

因為指定了 NoClobber 參數，如果目前目錄中已有 Alias.csv 檔案，這個命令會失敗。

範例 3

C:\PS>export-alias -path alias.csv -append -description "Appended Aliases" -force

描述
-----------
這個命令會將目前工作階段中的別名附加到 Alias.csv 檔案。

這個命令會使用 Description 參數將描述加到位於檔案頂端的註解。

也會使用 Force 參數覆寫任何現有的 Alias.csv 檔案，即使這些檔案有唯讀屬性也一樣。

範例 4

C:\PS>export-alias -path alias.ps1 -as script

C:\PS> add-content -path $profile -value (get-content alias.ps1)

C:\PS> $s = new-pssession -computername Server01
C:\PS> 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。

請參閱



目錄