ConvertTo-Xml

  • Referensi
Modul:
Microsoft.PowerShell.Utility

Membuat representasi objek berbasis XML.

Sintaks

ConvertTo-Xml
              [-Depth <Int32>]
              [-InputObject] <PSObject>
              [-NoTypeInformation]
              [-As <String>]
              [<CommonParameters>]

Deskripsi

ConvertTo-Xml Cmdlet membuat representasi berbasis XML dari satu atau beberapa objek .NET. Untuk menggunakan cmdlet ini, pipa satu atau beberapa objek ke cmdlet, atau gunakan parameter InputObject untuk menentukan objek.

Saat Anda menyalurkan beberapa objek ke ConvertTo-Xml atau menggunakan parameter InputObject untuk mengirimkan beberapa objek, ConvertTo-Xml mengembalikan dokumen XML dalam memori tunggal yang menyertakan representasi semua objek.

Cmdlet ini mirip dengan Export-Clixml kecuali yang menyimpan XML yang Export-Clixml dihasilkan dalam file Common Language Infrastructure (CLI) yang dapat direimportasi sebagai objek dengan Import-Clixml. ConvertTo-Xml mengembalikan representasi dalam memori dokumen XML, sehingga Anda dapat terus memprosesnya di PowerShell. ConvertTo-Xml tidak memiliki opsi untuk mengonversi objek ke CLI XML.

Contoh

Contoh 1: Mengonversi tanggal ke XML

Get-Date | ConvertTo-Xml

Perintah ini mengonversi tanggal saat ini ( objek DateTime ) ke XML.

Contoh 2: Mengonversi proses ke XML

ConvertTo-Xml -As "Document" -InputObject (Get-Process) -Depth 3

Perintah ini mengonversi objek proses yang mewakili semua proses di komputer menjadi dokumen XML. Objek diperluas ke kedalaman tiga tingkat.

Parameter

-As

Menentukan format output. Nilai yang dapat diterima untuk parameter ini adalah:

  • String - Mengembalikan satu string.
  • Stream - Mengembalikan array string.
  • Document - Mengembalikan objek XmlDocument .

Nilai defaultnya adalah Document.

Type:String
Accepted values:Stream, String, Document
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Depth

Menentukan berapa banyak tingkat objek yang terkandung yang disertakan dalam representasi XML. Nilai default adalah 1.

Misalnya, jika properti objek juga berisi objek, untuk menyimpan representasi XML dari properti objek yang terkandung, Anda harus menentukan kedalaman 2.

Nilai default dapat diganti untuk jenis objek dalam file Type.ps1xml. Untuk informasi selengkapnya, lihat about_Types.ps1xml.

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

-InputObject

Menentukan objek yang akan dikonversi. Masukkan variabel yang berisi objek, atau ketik perintah atau ekspresi yang mendapatkan objek. Anda juga dapat menyalurkan objek ke ConvertTo-XML.

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

-NoTypeInformation

Menghilangkan atribut Jenis dari simpul objek.

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

Input

PSObject

Anda dapat menyalurkan objek apa pun ke cmdlet ini

Output

String

Saat Anda menggunakan parameter Sebagai dan mengatur nilai ke string, cmdlet ini mengembalikan XML sebagai string. Ketika nilainya adalah stream, cmdlet ini mengembalikan array string.

XmlDocument

Secara default, cmdlet ini mengembalikan dokumen XML.