Condividi tramite

ConvertTo-Xml

Modulo:
Microsoft.PowerShell.Utility Module

Crea una rappresentazione basata su XML di un oggetto .

Sintassi

Default (impostazione predefinita). 

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

Descrizione

Il 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 invia tramite pipe più oggetti a o si usa il parametro inputObject per inviare più oggetti, 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 Common Language Infrastructure (CLI) che può essere reimportato come oggetti con Import-Clixml. ConvertTo-Xml restituisce una rappresentazione in memoria di un documento XML, quindi è possibile continuare a elaborarla in PowerShell. ConvertTo-Xml non ha un'opzione per convertire gli oggetti in XML CLI.

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 accettabili per questo parametro sono:

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

Il valore predefinito è Document.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Valori accettati:Stream, String, Document
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Depth

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

Ad esempio, se le proprietà dell'oggetto contengono anche oggetti, per salvare una rappresentazione XML delle proprietà degli oggetti contenuti, è necessario specificare una profondità pari a 2.

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

Proprietà dei parametri

Tipo:Int32
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-InputObject

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

Proprietà dei parametri

Tipo:PSObject
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:0
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-NoTypeInformation

Omette l'attributo Type dai nodi oggetto.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

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.