ConvertTo-Xml

  • Riferimento
Modulo:
Microsoft.PowerShell.Utility

Crea una rappresentazione basata su XML di un oggetto.

Sintassi

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

Descrizione

Il ConvertTo-Xml cmdlet crea una rappresentazione basata su XML di uno o più oggetti .NET. Per usare questo cmdlet, inviare tramite pipe uno o più oggetti al cmdlet oppure usare il parametro InputObject per specificare l'oggetto.

Quando si inviano tramite pipe più oggetti a ConvertTo-Xml o si utilizza il parametro InputObject per inviare più oggetti, ConvertTo-Xml restituisce un singolo documento XML in memoria che include rappresentazioni di tutti gli oggetti.

Questo cmdlet è simile a Export-Clixml , ad eccezione del fatto che Export-Clixml archivia il codice XML risultante in un file dell'interfaccia della riga di comando (Common Language Infrastructure) che può essere reimportato come oggetti con Import-Clixml. ConvertTo-Xml restituisce una rappresentazione in memoria di un documento XML, in modo da poter continuare a elaborarla in PowerShell. ConvertTo-Xml non dispone di un'opzione per convertire gli oggetti in XML dell'interfaccia della riga di comando.

Esempio

Esempio 1: Convertire una data in XML

Get-Date | ConvertTo-Xml

Questo comando converte la data corrente (un oggetto DateTime ) in XML.

Esempio 2: Convertire i processi in XML

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

Questo comando converte gli oggetti processo che rappresentano tutti i processi nel computer in un documento XML. Gli oggetti vengono espansi fino a una profondità di tre livelli.

Parametri

-As

Determina il formato di output. I valori validi per questo parametro sono:

  • String - Restituisce una singola stringa.
  • Stream : restituisce una matrice di stringhe.
  • Document - Restituisce un oggetto XmlDocument .

Il valore predefinito è Document.

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

-Depth

Specifica il numero di livelli di oggetti contenuti inclusi nella rappresentazione XML. Il valore predefinito è 1.

Se ad esempio anche le proprietà dell'oggetto contengono oggetti, per salvare una rappresentazione XML delle proprietà degli oggetti contenuti è necessario specificare 2 come profondità.

È possibile eseguire l'override del valore predefinito per il tipo di oggetto nei file Types.ps1xml. Per altre informazioni, vedere about_Types.ps1xml.

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

-InputObject

Specifica l'oggetto da convertire. Immettere una variabile che contiene gli oggetti oppure digitare un comando o un'espressione che ottiene gli oggetti. È anche possibile inviare oggetti tramite pipe a ConvertTo-XML.

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

-NoTypeInformation

Omette l'attributo Type dai nodi degli oggetti.

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

Input

PSObject

È possibile inviare tramite pipe qualsiasi oggetto a questo cmdlet

Output

String

Quando si usa il parametro As e si imposta il valore su string, questo cmdlet restituisce il codice XML come stringa. Quando il valore è stream, questo cmdlet restituisce una matrice di stringhe.

XmlDocument

Per impostazione predefinita, questo cmdlet restituisce un documento XML.