Freigeben über

ConvertTo-Xml

Modul:
Microsoft.PowerShell.Utility Module

Erstellt eine XML-basierte Darstellung eines Objekts.

Syntax

Default (Standard) 

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

Beschreibung

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

Wenn Sie mehrere Objekte über die Pipeline übergeben ConvertTo-Xml oder den InputObject-Parameter verwenden, um mehrere Objekte zu übermitteln, ConvertTo-Xml wird ein einzelnes XML-Dokument im Arbeitsspeicher zurückgegeben, das Darstellungen aller Objekte enthält.

Dieses Cmdlet ähnelt Export-Clixml , speichert Export-Clixml jedoch den resultierenden XML-Code in einer CLI-XML-Datei (Common Language Infrastructure), die als Objekte mit Import-Cligml erneut 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 eine Option zum Konvertieren von Objekten in CLI-XML.

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. Die zulässigen Werte für diesen Parameter sind:

  • 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.

Parametereigenschaften

Typ:String
Standardwert:None
Zulässige Werte:Stream, String, Document
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Depth

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

Wenn die Eigenschaften des Objekts beispielsweise auch Objekte enthalten, müssen Sie zum Speichern einer XML-Darstellung der Eigenschaften der enthaltenen Objekte eine Tiefe von 2 angeben.

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

Parametereigenschaften

Typ:Int32
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-InputObject

Gibt das zu konvertierende Objekt an. Geben Sie eine Variable ein, die die Objekte enthält, oder geben Sie einen Befehl oder Ausdruck ein, der die Objekte ermittelt. Sie können Objekte auch an ConvertTo-XMLverrohren.

Parametereigenschaften

Typ:PSObject
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:0
Obligatorisch:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-NoTypeInformation

Lässt das Type-Attribut von den Objektknoten aus.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

PSObject

Sie können jedes Objekt an ConvertTo-XMLpfeifen.

Ausgaben

System.String or System.Xml.XmlDocument

Der Wert des Parameters As bestimmt den Typ des Objekts, ConvertTo-XML das zurückgegeben wird.