Export-Clixml

模組:

Microsoft.PowerShell.Utility

建立物件或物件的 XML 型表示法，並將其儲存在檔案中。

語法

Export-Clixml
      [-Depth <Int32>]
      [-Path] <String>
      -InputObject <PSObject>
      [-Force]
      [-NoClobber]
      [-Encoding <Encoding>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Export-Clixml
      [-Depth <Int32>]
      -LiteralPath <String>
      -InputObject <PSObject>
      [-Force]
      [-NoClobber]
      [-Encoding <Encoding>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Export-Clixml Cmdlet 會將物件串行化為 Common Language Infrastructure （CLI） XML 型表示法，並將其儲存在檔案中。 接著，您可以使用 Import-Clixml Cmdlet，根據該檔案的內容重新建立儲存的物件。 如需 CLI 的詳細資訊，請參閱 語言獨立。

此 Cmdlet 類似於 ConvertTo-Xml，不同之處在於 Export-Clixml 會將產生的 XML 儲存在檔案中。 ConvertTo-XML 傳回 XML，因此您可以在 PowerShell 中繼續處理它。

在 Windows 電腦上有價值地使用 Export-Clixml，就是將認證和安全字串安全地導出為 XML。 如需範例，請參閱範例 3。

範例

範例 1：將字串匯出至 XML 檔案

這個範例會建立儲存在目前目錄中的 XML 檔案、字串的表示 這是測試。

"This is a test" | Export-Clixml -Path .\sample.xml

字串 This is a test 會在管線下傳送。 Export-Clixml 會使用 Path 參數，在目前目錄中建立名為 sample.xml 的 XML 檔案。

範例 2：將物件匯出至 XML 檔案

這個範例示範如何將對象匯出至 XML 檔案，然後從檔案匯入 XML 來建立 物件。

Get-Acl C:\test.txt | Export-Clixml -Path .\FileACL.xml
$fileacl = Import-Clixml -Path .\FileACL.xml

Get-Acl Cmdlet 會取得 Test.txt 檔案的安全性描述元。 它會將 物件傳送至管線，以將安全性描述元傳遞至 Export-Clixml。 物件的 XML 表示法會儲存在名為 FileACL.xml的檔案中。

Import-Clixml Cmdlet 會從 FileACL.xml 檔案中的 XML 建立 物件。 然後，它會將 物件儲存在 $fileacl 變數中。

範例 3：加密 Windows 上導出的認證物件

在此範例中，假設您已藉由執行 Get-Credential Cmdlet，將認證儲存在 $Credential 變數中，您可以執行 Export-Clixml Cmdlet，將認證儲存至磁碟。

重要

Export-Clixml 只會匯出 Windows 上的加密認證。 在macOS和Linux等非 Windows作系統上，認證會匯出為儲存為 Unicode 字元陣列的純文字。 這提供一些模糊化，但不提供加密。

$Credxmlpath = Join-Path (Split-Path $Profile) TestScript.ps1.credential
$Credential | Export-Clixml $Credxmlpath
$Credxmlpath = Join-Path (Split-Path $Profile) TestScript.ps1.credential
$Credential = Import-Clixml $Credxmlpath

Export-Clixml Cmdlet 會使用 Windows 資料保護 API來加密認證物件。 加密可確保只有該電腦上的用戶帳戶才能解密認證對象的內容。 導出的 CLIXML 檔案不能在不同的計算機上或由不同的使用者使用。

在此範例中，儲存認證的檔案會以 TestScript.ps1.credential表示。 將 TestScript 取代為您載入認證的腳本名稱。

您會將認證物件向下傳送至管線，以 Export-Clixml，並將它儲存至您在第一個命令中指定的路徑 $Credxmlpath。

若要自動將認證匯入腳本，請執行最後兩個命令。 執行 Import-Clixml，將受保護的認證物件匯入腳本中。 此匯入可消除在您的文稿中公開純文字密碼的風險。

範例 4：匯出 Linux 或 macOS 上的認證物件

在此範例中，我們會使用 Get-Credential Cmdlet，在 $Credential 變數中建立 PSCredential。 然後使用 Export-Clixml 將認證儲存至磁碟。

重要

Export-Clixml 只會匯出 Windows 上的加密認證。 在macOS和Linux等非 Windows作系統上，認證會匯出為儲存為 Unicode 字元陣列的純文字。 這提供一些模糊化，但不提供加密。

PS> $Credential = Get-Credential

PowerShell credential request
Enter your credentials.
User: User1
Password for user User1: ********

PS> $Credential | Export-Clixml ./cred2.xml
PS> Get-Content ./cred2.xml

...
    <Props>
      <S N="UserName">User1</S>
      <SS N="Password">700061007300730077006f0072006400</SS>
    </Props>
...

PS> 'password' | Format-Hex -Encoding unicode

   Label: String (System.String) <52D60C91>

          Offset Bytes                                           Ascii
                 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
          ------ ----------------------------------------------- -----
0000000000000000 70 00 61 00 73 00 73 00 77 00 6F 00 72 00 64 00 p a s s w o r d

此範例中 Get-Content 的輸出已截斷，以專注於 XML 檔案中的認證資訊。 請注意，密碼的純文本值會儲存在 XML 檔案中，做為 Unicode 字元陣列，如 Format-Hex所證明。 因此，值會經過編碼，但未加密。

參數

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

類型:	SwitchParameter
別名:	cf
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Depth

指定 XML 表示法中包含多少個自主物件的層級。 預設值為 2。

您可以覆寫 Types.ps1xml 檔案中物件類型的預設值。 如需詳細資訊，請參閱 about_Types.ps1xml。

類型:	Int32
Position:	Named
預設值:	2
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Encoding

指定目標檔案的編碼類型。 預設值為 utf8NoBOM。

此參數可接受的值如下：

• ascii：使用 ASCII （7 位） 字元集的編碼方式。
• ansi：針對目前文化特性的 ANSI 代碼頁，使用 的編碼方式。 此選項已在 7.4 中新增。
• bigendianunicode：使用 big-endian 位元組順序以 UTF-16 格式編碼。
• bigendianutf32：使用 big-endian 位元組順序以 UTF-32 格式編碼。
• oem：使用 MS-DOS 和控制台程序的預設編碼方式。
• unicode：使用位元組順序以UTF-16格式編碼。
• utf7：以UTF-7格式編碼。
• utf8：以UTF-8格式編碼。
• utf8BOM：使用位元組順序標記以 UTF-8 格式編碼（BOM）
• utf8NoBOM：以 UTF-8 格式編碼，不含位元組順序標記 （BOM）
• utf32：以UTF-32格式編碼。

從 PowerShell 6.2 開始，編碼 參數也允許已註冊代碼頁的數值識別元（例如 -Encoding 1251）或已註冊代碼頁的字串名稱（例如 -Encoding "windows-1251"）。 如需詳細資訊，請參閱 Encoding.CodePage的 .NET 檔。

從 PowerShell 7.4 開始，您可以使用 Encoding 參數的 Ansi 值，傳遞目前文化特性 ANSI 代碼頁的數值標識符，而不需要手動指定。

注意

UTF-7* 不再建議使用。 自 PowerShell 7.1 起，如果您為 Encoding 參數指定 utf7，則會撰寫警告。

類型:	Encoding
接受的值:	ASCII, BigEndianUnicode, BigEndianUTF32, OEM, Unicode, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32
Position:	Named
預設值:	UTF8NoBOM
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Force

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

必要時，Cmdlet 會清除輸出檔的唯讀屬性。 Cmdlet 會在命令完成時嘗試重設只讀屬性。

類型:	SwitchParameter
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-InputObject

指定要轉換的物件。 輸入包含 物件的變數，或輸入取得物件的命令或表達式。 您也可以使用管線將物件傳送至 Export-Clixml。

類型:	PSObject
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-LiteralPath

指定將儲存物件之 XML 表示的檔案路徑。 與 Path不同，LiteralPath 參數的值會與類型完全相同。 不會將任何字元解譯為通配符。 如果路徑包含逸出字元，請以單引弧括住它。 單引號會告知PowerShell不要將任何字元解譯為逸出序列。

類型:	String
別名:	PSPath, LP
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-NoClobber

指出 Cmdlet 不會覆寫現有檔案的內容。 根據預設，如果檔案存在於指定的路徑中，Export-Clixml 會覆寫檔案而不發出警告。

類型:	SwitchParameter
別名:	NoOverwrite
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Path

指定將儲存物件之 XML 表示的檔案路徑。

類型:	String
Position:	0
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。

類型:	SwitchParameter
別名:	wi
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

輸入

PSObject

您可以將任何物件管線至此 Cmdlet。

輸出

FileInfo

此 Cmdlet 會傳回 FileInfo 物件，此物件代表具有預存數據的已建立檔案。

相關連結

• ConvertTo-Html
• ConvertTo-Xml
• Export-Csv
• Import-Clixml
• Join-Path
• 安全地將認證儲存在磁碟上
• 使用 PowerShell 將認證傳遞至舊版系統
• Windows.Security.Cryptography.DataProtection