ConvertTo-Xml
オブジェクトの XML ベースの表現を作成します。
構文
ConvertTo-Xml
[-InputObject] <PSObject>
[-Depth <Int32>]
[-NoTypeInformation]
[-As <String>]
[<CommonParameters>] 説明
ConvertTo-Xml コマンドレットは、1 つ以上の Microsoft .NET Framework オブジェクトの XML ベースの表現を作成します。
このコマンドレットを使用するには、1 つ以上のオブジェクトをコマンドレットにパイプ処理するか、InputObject パラメーターを使用してオブジェクトを指定します。
複数のオブジェクトを ConvertTo-Xml にパイプ処理するか、 InputObject パラメータを使用して複数のオブジェクトを送信すると、 ConvertTo-Xml はすべてのオブジェクトの表現を含む 1 つの XML ドキュメントを返します。
このコマンドレットは Export-Clixml と似ていますが、結果の XML をファイルに格納する点が異なります Export-Clixml 。
ConvertTo-Xml は XML を返すので、引き続き PowerShell で処理できます。
例
例 1: 日付を XML に変換する
PS C:\> Get-Date | ConvertTo-Xmlこのコマンドは、現在の日付 (DateTime オブジェクト) を XML に変換します。
例 2: プロセスを XML に変換する
PS C:\> ConvertTo-Xml -As "Document" -InputObject (Get-Process) -Depth 3このコマンドは、コンピュータ上のすべてのプロセスを表すプロセスオブジェクトを XML ドキュメントに変換します。 オブジェクトは、3 つのレベルの深さに拡張されます。
パラメーター
-As
出力形式を決定します。 このパラメーターに使用できる値は次のとおりです。
- 文字列 1 つの文字列を返します。
- 川。 文字列の配列を返します。
- 文書 XmlDocument オブジェクトを返します。
デフォルト値は [ドキュメント] です。
| 型: | String |
| 指定可能な値: | Stream, String, Document |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Depth
XML 表現に含まれる包含オブジェクトのレベルの数を指定します。 既定値は 1 です。
たとえば、オブジェクトのプロパティにもオブジェクトが含まれている場合、含まれているオブジェクトのプロパティの XML 表現を保存するには、深さを 2 に指定する必要があります。
Types.ps1xml ファイル内のオブジェクト型の既定値をオーバーライドできます。 詳細については、「about_Types.ps1xml」を参照してください。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InputObject
変換するオブジェクトを指定します。 オブジェクトを含む変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。 オブジェクトを ConvertTo-XML にパイプ処理することもできます。
| 型: | PSObject |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-NoTypeInformation
オブジェクト ノードから Type 属性を省略します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
任意のオブジェクトを ConvertTo-XML にパイプ処理できます。
出力
System.String or System.Xml.XmlDocument
As パラメーターの値によって、ConvertTo-XML が返すオブジェクトの型が決まります。