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 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 來建立會話。第四個命令會使用 Cmdlet 的 Invoke-Command 參數，在新會話中執行 Alias.ps1 檔案。

參數

-Append

指出這個 Cmdlet 會將輸出附加至指定的檔案，而不是覆寫該檔案的現有內容。

參數屬性

類型:	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
別名:	cf

參數集

(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 檔案。

意見反應

此頁面對您有幫助嗎？

共用方式為

Export-Alias

語法

ByPath (預設值)

ByLiteralPath

Description

範例

範例 1：導出別名

範例 2：除非匯出檔案已經存在，否則匯出別名

範例 3：將別名附加至檔案

範例 4：將別名匯出為腳本

參數

-Append

參數屬性

參數集

-As

參數屬性

參數集

-Confirm

參數屬性

參數集

-Description

參數屬性

參數集

-Force

參數屬性

參數集

-LiteralPath

參數屬性

參數集

-Name

參數屬性

參數集

-NoClobber

參數屬性

參數集

-PassThru

參數屬性

參數集

-Path

參數屬性

參數集

-Scope

參數屬性

參數集

-WhatIf

參數屬性

參數集

CommonParameters

輸入

None

輸出

None

AliasInfo

備註

相關連結

意見反應