ConvertTo-Xml

Modul:
Microsoft.PowerShell.Utility Module

Skapar en XML-baserad representation av ett objekt.

Syntax

Default (Standard) 

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

Description

Cmdleten ConvertTo-Xml skapar en XML-baserad representation av ett eller flera .NET-objekt. Om du vill använda den här cmdleten kan du skicka ett eller flera objekt till cmdleten eller använda parametern InputObject för att ange objektet.

När du skickar flera objekt till ConvertTo-Xml eller använder parametern InputObject för att skicka flera objekt ConvertTo-Xml returneras ett enda XML-dokument i minnet som innehåller representationer av alla objekt.

Den här cmdleten liknar Export-Clixml förutom att Export-Clixml den resulterande XML-koden lagras i en XML-fil med Common Language Infrastructure (CLI) som kan importeras om som objekt med Import-Clixml. ConvertTo-Xml returnerar en minnesintern representation av ett XML-dokument så att du kan fortsätta att bearbeta det i PowerShell. ConvertTo-Xml har inte möjlighet att konvertera objekt till CLI XML.

Exempel

Exempel 1: Konvertera ett datum till XML

Get-Date | ConvertTo-Xml

Det här kommandot konverterar det aktuella datumet (ett DateTime--objekt) till XML.

Exempel 2: Konvertera processer till XML

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

Det här kommandot konverterar processobjekten som representerar alla processer på datorn till ett XML-dokument. Objekten expanderas till ett djup av tre nivåer.

Parametrar

-As

Avgör utdataformatet. De godtagbara värdena för den här parametern är:

  • String Returnerar en enskild sträng.
  • Stream Returnerar en matris med strängar.
  • Document Returnerar ett XmlDocument-objekt .

Standardvärdet är Document.

Parameteregenskaper

Typ:String
Standardvärde:None
Godkända värden:Stream, String, Document
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Depth

Anger hur många nivåer av inneslutna objekt som ingår i XML-representationen. Standardvärdet är 1.

Om objektets egenskaper till exempel också innehåller objekt måste du ange ett djup på 2 för att spara en XML-representation av egenskaperna för de inneslutna objekten.

Standardvärdet kan åsidosättas för objekttypen i filerna Types.ps1xml. Mer information finns i about_Types.ps1xml.

Parameteregenskaper

Typ:Int32
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-InputObject

Anger det objekt som ska konverteras. Ange en variabel som innehåller objekten eller skriv ett kommando eller uttryck som hämtar objekten. Du kan också skicka objekt till ConvertTo-XML.

Parameteregenskaper

Typ:PSObject
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:0
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-NoTypeInformation

Utelämnar typattributet från objektnoderna.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

PSObject

Du kan skicka valfritt objekt till ConvertTo-XML.

Utdata

System.String or System.Xml.XmlDocument

Värdet för parametern As avgör vilken typ av objekt som ConvertTo-XML returneras.