Export-Clixml

创建一个或多个对象的基于 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>]

说明

Export-Clixml cmdlet 创建公共语言基础结构 (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。 The XML-based representation of the object is stored in a file named FileACL.xml.

Import-Clixml cmdlet 从文件中的 XML FileACL.xml 创建对象。 然后,它将对象保存在变量中 $fileacl

示例 3:加密 Windows 上的导出凭据对象

在此示例中,给定通过运行 cmdlet 存储在变量中的 $Credential 凭据,可以运行 Get-CredentialExport-Clixml cmdlet 以将凭据保存到磁盘。

重要

Export-Clixml 仅导出 Windows 上的加密凭据。 在非 Windows 操作系统(如 macOS 和 Linux)上,凭据将导出为以 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 上导出凭据对象

在此示例中,我们使用 cmdlet 在$Credential变量Get-Credential中创建 PSCredential。 然后,我们将凭据 Export-Clixml 保存到磁盘。

重要

Export-Clixml 仅导出 Windows 上的加密凭据。 在非 Windows 操作系统(如 macOS 和 Linux)上,凭据将导出为以 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 文件中的凭据信息。 请注意,密码的纯文本值以 Unicode 字符数组的形式存储在 XML 文件中,经 Format-Hex验证。 因此,该值已编码,但未加密。

参数

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-Depth

指定 XML 表示形式中所包含的包含对象的级别数。 默认值为 2

可以为文件中的对象类型 Types.ps1xml 重写默认值。 有关详细信息,请参阅 about_Types.ps1xml

Type:Int32
Position:Named
Default value:2
Accept pipeline input:False
Accept wildcard characters:False

-Encoding

指定目标文件的编码类型。 默认值为 utf8NoBOM

此参数的可接受值如下所示:

  • ascii:对 ASCII (7 位) 字符集使用编码。
  • bigendianunicode:使用 big-endian 字节顺序以 UTF-16 格式进行编码。
  • bigendianutf32:使用 big-endian 字节顺序以 UTF-32 格式进行编码。
  • oem:对 MS-DOS 和控制台程序使用默认编码。
  • unicode:使用小端字节顺序以 UTF-16 格式进行编码。
  • utf7:采用 UTF-7 格式编码。
  • utf8:采用 UTF-8 格式编码。
  • utf8BOM:使用字节顺序标记 (BOM) 编码 UTF-8 格式
  • utf8NoBOM:不带字节顺序标记的 UTF-8 格式编码 (BOM)
  • utf32:采用 UTF-32 格式编码。

从 PowerShell 6.2 开始, 编码 参数还允许注册代码页的数值 ID (如 -Encoding 1251) 或注册代码页的字符串名称 (,如 -Encoding "windows-1251") 。 有关详细信息,请参阅 Encoding.CodePage 的 .NET 文档。

备注

不再建议使用 UTF-7* 。 从 PowerShell 7.1 起,如果为编码参数指定utf7,则会编写警告。

Type:Encoding
Accepted values:ASCII, BigEndianUnicode, BigEndianUTF32, OEM, Unicode, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32
Position:Named
Default value:UTF8NoBOM
Accept pipeline input:False
Accept wildcard characters:False

-Force

强制运行命令而不要求用户确认。

使该 cmdlet 清除输出文件的只读属性(如有必要)。 该 cmdlet 将在命令完成时尝试重置只读属性。

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

指定要转换的对象。 输入一个包含对象的变量,或键入可获取对象的命令或表达式。 还可以通过管道将对象传递给 Export-Clixml

Type:PSObject
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

指定指向将存储对象的 XML 表示形式的文件的路径。 与 Path 不同, 文本路径 参数的值与类型化完全一样使用。 不会将任何字符解释为通配符。 如果路径包括转义符,请将其括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

Type:String
Aliases:PSPath, LP
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-NoClobber

指示 cmdlet 不会覆盖现有文件的内容。 默认情况下,如果指定路径中存在文件, Export-Clixml 则覆盖文件而不发出警告。

Type:SwitchParameter
Aliases:NoOverwrite
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

指定指向将存储对象的 XML 表示形式的文件的路径。

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

显示在此 cmdlet 运行的情况下将会发生什么。 cmdlet 未运行。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

输入

PSObject

可以将任何对象管道传递给 Export-Clixml

输出

FileInfo

Export-Clixml 创建包含 XML 的文件。