Export-Alias

模組:

Microsoft.PowerShell.Utility Module

將目前定義別名的資訊匯出到檔案。

語法

ByPath (預設值)

Export-Alias
    [-Path] <String>
    [[-Name] <String[]>]
    [-PassThru]
    [-As <ExportAliasFormat>]
    [-Append]
    [-Force]
    [-NoClobber]
    [-Description <String>]
    [-Scope <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByLiteralPath

Export-Alias
    [[-Name] <String[]>]
    -LiteralPath <String>
    [-PassThru]
    [-As <ExportAliasFormat>]
    [-Append]
    [-Force]
    [-NoClobber]
    [-Description <String>]
    [-Scope <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Export-Alias指令檔會將當前會話中的別名匯出到檔案中。 如果輸出檔不存在，指令小程式會自動產生它。

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-Command 參數在新會話中執行 Alias.ps1 檔案。

參數

-Append

表示此指令檔會將輸出附加到指定檔案，而非覆蓋該檔案的既有內容。

參數屬性

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

參數集

(All)

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

-As

指定輸出格式。 CSV 是預設的。 此參數可接受的值為：

• CSV。 逗號分隔值（CSV）格式。
• 指令碼： 為每個匯出的別名建立指令 Set-Alias 。 如果你用副檔名命名輸出檔 .ps1 名，就可以執行它作為腳本，將別名加入任何工作階段。

參數屬性

類型:	ExportAliasFormat
預設值:	None
接受的值:	Csv, Script
支援萬用字元:	False
不要顯示:	False

參數集

(All)

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

-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

強制命令執行，而不要求使用者確認。

即使該檔案設定了唯讀屬性，也會覆蓋輸出檔。

預設情況下， Export-Alias 除非設定唯讀或隱藏屬性，或指令中使用 NoClobber 參數，否則會無預警覆寫檔案。 當 NoClobber 參數同時用於指令時，優先於 Force 參數。

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

參數屬性

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

參數集

(All)

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

-LiteralPath

指定輸出檔的路徑。 不同於 Path，LiteralPath 參數的值完全按照輸入的方式使用。 不會將任何字元解譯為通配符。 如果路徑包含逸出字元，請以單引弧括住它。 單引號會告知PowerShell不要將任何字元解譯為逸出序列。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	PSPath, LP

參數集

ByLiteralPath

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

-Name

指定名稱作為一組別名陣列，以便匯出。 允許使用通配符。

預設情況下，會 Export-Alias 匯出會話或作用域中的所有別名。

參數屬性

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

參數集

(All)

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

-NoClobber

表示此 cmdlet 防止 Export-Alias 覆蓋任何檔案，即使指令中使用 了 Force 參數。

若未包含 NoClobber 參數， Export-Alias 將無預警覆寫現有檔案，除非該檔案設定唯讀屬性。 NoClobber 優先於 Force 參數，後者允許 Export-Alias 覆寫具有唯讀屬性的檔案。

NoClobber 並不會阻止 Append 參數將內容加入現有檔案。

參數屬性

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

參數集

(All)

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

-PassThru

返回一個物件，代表您正在處理的項目。 根據預設，此 Cmdlet 不會產生任何輸出。

參數屬性

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

參數集

(All)

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

-Path

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

參數屬性

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

參數集

ByPath

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

-Scope

指定別名應從何處匯出。 此參數可接受的值為：

• Global
• Local
• Script
• 相對於目前範圍的數字（0 除以範圍數，其中 0 為當前範圍，1 為其父範圍）

預設值為 Local。 如需詳細資訊，請參閱 about_Scopes。

參數屬性

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

參數集

(All)

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

-WhatIf

顯示 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 包含下列 Export-Alias的別名：

• 所有平臺：
  • epal

• 你只能 Export-Aliases 檔案。

相關連結

• Get-Alias
• Import-Alias
• 新別名 (New-Alias)
• Set-Alias