ConvertTo-Xml
オブジェクトの XML ベースの表現を作成します。
構文
Default (既定)
ConvertTo-Xml
[-Depth <Int32>]
[-InputObject] <PSObject>
[-NoTypeInformation]
[-As <String>]
[<CommonParameters>]
説明
ConvertTo-Xml コマンドレットは、1 つ以上の .NET オブジェクトの XML ベースの 表現を作成します。 このコマンドレットを使用するには、1 つ以上のオブジェクトをコマンドレットにパイプ処理するか、InputObject パラメーターを使用してオブジェクトを指定します。
複数のオブジェクトをパイプ処理して ConvertTo-Xml したり、InputObject パラメーターを使用して複数のオブジェクトを送信したりすると、ConvertTo-Xml はすべてのオブジェクトの表現を含む単一のインメモリ XML ドキュメントを返します。
このコマンドレットは、Export-Clixml に似ていますが、Export-Clixml は、共通言語インフラストラクチャ (CLI) ファイルに結果の XML を格納します。このファイルは、Import-Clixml オブジェクトとして再インポートできます。
ConvertTo-Xml は XML ドキュメントのメモリ内表現を返します。そのため、PowerShell で引き続き処理できます。
ConvertTo-Xml には、オブジェクトを CLI XML に変換するオプションはありません。
例
例 1: 日付を XML に変換する
Get-Date | ConvertTo-Xml
このコマンドは、現在の日付 (DateTime オブジェクト) を XML に変換します。
例 2: プロセスを XML に変換する
ConvertTo-Xml -As "Document" -InputObject (Get-Process) -Depth 3
このコマンドは、コンピューター上のすべてのプロセスを表すプロセス オブジェクトを XML ドキュメントに変換します。 オブジェクトは、3 つのレベルの深さに拡張されます。
パラメーター
-As
出力形式を決定します。 このパラメーターに使用できる値は次のとおりです。
-
String- 1 つの文字列を返します。 -
Stream- 文字列の配列を返します。 -
Document- XmlDocument オブジェクトを返します。
既定値は Document です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| 指定可能な値: | Stream, String, Document |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Depth
XML 表現に含まれる包含オブジェクトのレベルの数を指定します。 既定値は 1 です。
たとえば、オブジェクトのプロパティにもオブジェクトが含まれている場合、含まれているオブジェクトのプロパティの XML 表現を保存するには、深さ 2 を指定する必要があります。
Types.ps1xml ファイル内のオブジェクト型の既定値をオーバーライドできます。 詳細については、about_Types.ps1xmlを参照してください。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InputObject
変換するオブジェクトを指定します。 オブジェクトを含む変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。 オブジェクトを ConvertTo-Xmlに送ることもできます。
パラメーターのプロパティ
| 型: | PSObject |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NoTypeInformation
オブジェクト ノードから Type 属性を省略します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
PSObject
任意のオブジェクトをこのコマンドレットにパイプできます
出力
String
As パラメーターを使用し、値を stringに設定すると、このコマンドレットは XML を文字列として返します。 値が streamされると、このコマンドレットは文字列の配列を返します。
XmlDocument
既定では、このコマンドレットは XML ドキュメントを返します。
