Export-Clixml

モジュール:: Microsoft.PowerShell.Utility

オブジェクトまたはオブジェクトの XML ベースの表現を作成し、ファイルに格納します。

構文

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

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

説明

Export-Clixml コマンドレットは、共通言語基盤 (CLI) XML ベースのオブジェクト表現を作成し、それをファイルに格納します。その後、Import-Clixml コマンドレットを使用して、そのファイルの内容に基づいて保存されたオブジェクトを再作成できます。 CLI の詳細については、「言語に依存する」を参照してください。

このコマンドレットは ConvertTo-Xmlに似ていますが、結果の XML Export-Clixml ファイルに格納される点が異なります。 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 コマンドレットは、Test.txt ファイルのセキュリティ記述子を取得します。パイプラインの下にオブジェクトを送信して、セキュリティ記述子を Export-Clixmlに渡します。オブジェクトの XML ベースの表現は、FileACL.xmlという名前のファイルに格納されます。

Import-Clixml コマンドレットは、FileACL.xml ファイル内の XML からオブジェクトを作成します。次に、オブジェクトを $fileacl 変数に保存します。

例 3: エクスポートされた資格情報オブジェクトを暗号化する

この例では、$Credential コマンドレットを実行して Get-Credential 変数に格納した資格情報を指定すると、Export-Clixml コマンドレットを実行して資格情報をディスクに保存できます。

Von Bedeutung

Export-Clixml は、Windows で暗号化された資格情報のみをエクスポートします。 macOS や Linux などの Windows 以外のオペレーティングシステムでは、資格情報はプレーンテキストでエクスポートされます。

$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 コマンドレットは、Windows Data Protection APIを使用して資格情報オブジェクトを暗号化します。暗号化により、そのコンピューター上のユーザーアカウントのみが資格情報オブジェクトの内容の暗号化を解除できるようになります。エクスポートされた CLIXML ファイルを別のコンピューターまたは別のユーザーで使用することはできません。

この例では、資格情報が格納されているファイルは TestScript.ps1.credentialで表されます。 TestScript を、資格情報を読み込むスクリプトの名前に置き換えます。

パイプラインの下に資格情報オブジェクトを送信して Export-Clixmlし、最初のコマンドで指定したパス ($Credxmlpath) に保存します。

資格情報をスクリプトに自動的にインポートするには、最後の 2 つのコマンドを実行します。 Import-Clixml を実行して、セキュリティで保護された資格情報オブジェクトをスクリプトにインポートします。このインポートにより、スクリプト内のプレーンテキストパスワードが公開されるリスクがなくなります。

パラメーター

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Depth

XML 表現に含まれる包含オブジェクトのレベルの数を指定します。既定値は 2 です。

Types.ps1xml ファイル内のオブジェクト型の既定値をオーバーライドできます。詳細については、about_Types.ps1xmlを参照してください。

型:	Int32
配置:	Named
規定値:	2
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Encoding

ターゲットファイルのエンコードの種類を指定します。既定値は Unicode です。

このパラメーターに使用できる値は次のとおりです。

ASCII ASCII (7 ビット) 文字セットを使用します。
BigEndianUnicode では、ビッグエンディアンバイト順で UTF-16 を使用します。
既定の システムのアクティブなコードページ (通常は ANSI) に対応するエンコードを使用します。
OEM システムの現在の OEM コードページに対応するエンコードを使用します。
Unicode では、リトルエンディアンバイト順で UTF-16 が使用されます。
UTF7 UTF-7 を使用します。
UTF8 は UTF-8 を使用します。
UTF32 では、リトルエンディアンバイト順で UTF-32 が使用されます。

型:	String
指定可能な値:	ASCII, BigEndianUnicode, Default, OEM, Unicode, UTF7, UTF8, UTF32
配置:	Named
規定値:	Unicode
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Force

ユーザーの確認を求めずにコマンドを強制的に実行します。

必要に応じて、コマンドレットで出力ファイルの読み取り専用属性をクリアします。コマンドレットは、コマンドの完了時に読み取り専用属性のリセットを試みます。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

変換するオブジェクトを指定します。オブジェクトを含む変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。オブジェクトを Export-Clixmlに送ることもできます。

型:	PSObject
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-LiteralPath

オブジェクトの XML 表現が格納されるファイルへのパスを指定します。 Pathとは異なり、LiteralPath パラメーターの値は、型指定されたとおりに使用されます。ワイルドカードとして解釈される文字はありません。パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。単一引用符は、エスケープシーケンスとして文字を解釈しないように PowerShell に指示します。

型:	String
Aliases:	PSPath
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NoClobber

コマンドレットが既存のファイルの内容を上書きしないことを示します。既定では、指定したパスにファイルが存在する場合、Export-Clixml は警告なしでファイルを上書きします。

型:	SwitchParameter
Aliases:	NoOverwrite
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Path

オブジェクトの XML 表現が格納されるファイルへのパスを指定します。

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSObject

任意のオブジェクトを Export-Clixmlにパイプライン処理できます。

出力

FileInfo

Export-Clixml XML を含むファイルを作成します。