Crea una representación basada en XML de un objeto.

Sintaxis

ConvertTo-XML [-InputObject] <psobject> [-As <string>] [-Depth <int>] [-NoTypeInformation] [<CommonParameters>]

Descripción

El cmdlet ConvertTo-Xml crea una representación basada en XML de uno o varios objetos de Microsoft .NET Framework. Para utilizar este cmdlet, canalice uno o varios objetos al cmdlet o utilice el parámetro InputObject para especificar el objeto.

Cuando se canalizan varios objetos a ConvertTo-XML o se utiliza el parámetro InputObject para enviar varios objetos, ConvertTo-XML devuelve un solo documento XML que incluye representaciones de todos los objetos.

Este cmdlet es similar a Export-Clixml, salvo en que Export-Clixml almacena el XML resultante en un archivo. ConvertTo-XML devuelve el XML de modo que se puede continuar procesándolo en Windows PowerShell.

Parámetros

-As <string>

Determina el formato de los resultados. Los valores válidos son:

-- String: devuelve una sola cadena.

-- Stream: devuelve una matriz de cadenas.

-- Document: devuelve un objeto XmlDocument.

Stream es el valor predeterminado.

¿Requerido?

false

¿Posición?

named

Valor predeterminado

Stream

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-Depth <int>

Especifica el número de niveles de objetos contenidos que se incluye en la representación XML. El valor predeterminado es 1.

Por ejemplo, si las propiedades del objeto también contienen objetos, para guardar una representación XML de las propiedades de los objetos contenidos, debe especificar una profundidad de 2.

El valor predeterminado se puede invalidar para el tipo de objeto en los archivos Types.ps1xml. Para obtener más información, vea about_Types.ps1xml.

¿Requerido?

false

¿Posición?

named

Valor predeterminado

1

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-InputObject <psobject>

Especifica el objeto que se va a convertir. Especifique la variable que contiene los objetos, o bien, escriba un comando o una expresión que obtenga los objetos. También puede canalizar los objetos a ConvertTo-XML.

¿Requerido?

true

¿Posición?

1

Valor predeterminado

ninguno

¿Aceptar canalización?

true (ByValue)

¿Aceptar caracteres comodín?

true

-NoTypeInformation

Omite el atributo Type de los nodos de objeto.

¿Requerido?

false

¿Posición?

named

Valor predeterminado

False

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

<CommonParameters>

Este cmdlet admite los parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, vea about_Commonparameters.

Entradas y salidas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet. El tipo devuelto es el tipo de los objetos que el cmdlet devuelve.

Entradas

System.Management.Automation.PSObject

Puede canalizar cualquier objeto a ConvertTo-XML.

Salidas

System.String o System.Xml.XmlDocument

El valor del parámetro As determina el tipo del objeto que ConvertTo-XML devuelve.

Ejemplo 1

C:\PS>get-date | convertto-xml

Descripción
-----------
Este comando convierte la fecha actual (objeto DateTime) en XML.






Ejemplo 2

C:\PS>convertto-xml -as Document -inputObject (get-process) -depth 3

Descripción
-----------
Este comando convierte en un documento XML los objetos de proceso que representan todos los procesos del equipo. Los objetos se expanden a una profundidad de tres niveles.






Vea también




Tabla de contenido