Bagikan melalui

ConvertTo-Xml

Modul:
Microsoft.PowerShell.Utility Module

Membuat representasi objek berbasis XML.

Sintaks

Default (Default) 

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

Deskripsi

Cmdlet ConvertTo-Xml 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 satu dokumen XML dalam memori yang menyertakan representasi semua objek.

Cmdlet ini mirip dengan Export-Clixml kecuali bahwa Export-Clixml menyimpan XML yang 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.

Properti parameter

Jenis:String
Nilai default:None
Nilai yang diterima:Stream, String, Document
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Depth

Menentukan berapa banyak tingkat objek yang terkandung yang disertakan dalam representasi XML. Nilai defaultnya 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.

Properti parameter

Jenis:Int32
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa: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.

Properti parameter

Jenis:PSObject
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:0
Wajib:True
Nilai dari alur:True
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-NoTypeInformation

Menghilangkan atribut Jenis dari simpul objek.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

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. Saat nilai stream, cmdlet ini mengembalikan array string.

XmlDocument

Secara default, cmdlet ini mengembalikan dokumen XML.