ConvertTo-Xml
オブジェクトの XML ベースの表現を作成します。
構文
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
、結果の XML は、Import-Clixml を使用してオブジェクトとして再インポートできる共通言語インフラストラクチャ (CLI) ファイルに格納されます。 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
です。
Type: | String |
Accepted values: | Stream, String, Document |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Depth
XML 表現に含める子オブジェクトのレベルを指定します。 既定値は 1 です。
たとえば、オブジェクトのプロパティにオブジェクトが含まれる場合、子オブジェクトのプロパティの XML 表現を保存するには、深さのレベルとして 2 を指定する必要があります。
既定値は、Types.ps1xml ファイル内のオブジェクトの型に対してオーバーライドできます。 詳細については、「 about_Types.ps1xml」を参照してください。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
変換するオブジェクトを指定します。 オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。 オブジェクトを に ConvertTo-XML
パイプすることもできます。
Type: | PSObject |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NoTypeInformation
オブジェクト ノードから Type 属性を削除します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
任意のオブジェクトをこのコマンドレットにパイプできます
出力
As パラメーターを使用して 値を にstring
設定すると、このコマンドレットは XML を文字列として返します。 値が の場合、このコマンドレットは stream
文字列の配列を返します。
既定では、このコマンドレットは XML ドキュメントを返します。