ConvertTo-Xml

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Erstellt eine XML-basierte Darstellung eines Objekts.

Syntax

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

Beschreibung

Das ConvertTo-Xml Cmdlet erstellt eine XML-basierte Darstellung eines oder mehrerer .NET-Objekte. Um dieses Cmdlet zu verwenden, übergeben Sie ein oder mehrere Objekte an das Cmdlet, oder verwenden Sie den InputObject-Parameter , um das Objekt anzugeben.

Wenn Sie mehrere Objekte an ConvertTo-Xml den InputObject-Parameter übergeben oder zum Senden mehrerer Objekte verwenden, wird ein einzelnes XML-Dokument im Arbeitsspeicher zurückgegeben, ConvertTo-Xml das Darstellungen aller Objekte enthält.

Dieses Cmdlet ähnelt Export-Clixml , mit der Ausnahme, dass Export-Clixml die resultierende XML-Datei in einer CLI-Datei (Common Language Infrastructure) gespeichert wird, die als Objekte mit Import-Clixml neu importiert werden kann. ConvertTo-Xml gibt eine Speicherdarstellung eines XML-Dokuments zurück, sodass Sie es weiterhin in PowerShell verarbeiten können. ConvertTo-Xml verfügt nicht über die Möglichkeit, Objekte in CLI-XML zu konvertieren.

Beispiele

Beispiel 1: Konvertieren eines Datums in XML

Get-Date | ConvertTo-Xml

Mit diesem Befehl wird das aktuelle Datum (ein DateTime-Objekt ) in XML konvertiert.

Beispiel 2: Konvertieren von Prozessen in XML

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

Mit diesem Befehl werden die Prozessobjekte, die alle Prozesse auf dem Computer darstellen, in ein XML-Dokument konvertiert. Die Objekte werden auf eine Tiefe von drei Ebenen erweitert.

Parameter

-As

Bestimmt das Ausgabeformat. Zulässige Werte für diesen Parameter:

  • String - Gibt eine einzelne Zeichenfolge zurück.
  • Stream - Gibt ein Array von Zeichenfolgen zurück.
  • Document - Gibt ein XmlDocument-Objekt zurück.

Der Standardwert ist Document.

Typ:String
Zulässige Werte:Stream, String, Document
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Depth

Gibt an, wie viele Ebenen der enthaltenen Objekte in der XML-Darstellung enthalten sind. Der Standardwert ist 1.

Wenn beispielsweise die Eigenschaften des Objekts ebenfalls Objekte enthalten, müssen Sie eine Tiefe von 2 angeben, um eine XML-Darstellung der Eigenschaften der enthaltenen Objekte zu speichern.

Der Standardwert kann für den Objekttyp in den Dateien „Types.ps1xml“ überschrieben werden. Weitere Informationen finden Sie unter about_Types.ps1xml.

Typ:Int32
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-InputObject

Gibt das zu konvertierende Objekt an. Geben Sie eine Variable ein, die die Objekte enthält, oder geben Sie einen Befehl oder einen Ausdruck ein, mit dem die Objekte abgerufen werden. Sie können objekte auch an ConvertTo-XML.

Typ:PSObject
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-NoTypeInformation

Lässt das Type-Attribute in den Objektknoten aus.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

PSObject

Sie können jedes Objekt an dieses Cmdlet weiterleiten.

Ausgaben

String

Wenn Sie den Parameter As verwenden und den Wert auf stringfestlegen, gibt dieses Cmdlet den XML-Code als Zeichenfolge zurück. Wenn der Wert lautet stream, gibt dieses Cmdlet ein Array von Zeichenfolgen zurück.

XmlDocument

Standardmäßig gibt dieses Cmdlet ein XML-Dokument zurück.