Compartir a través de

ConvertTo-Xml

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

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

Sintaxis

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

Description

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

Al canalizar varios objetos a ConvertTo-Xml o usar el parámetro InputObject para enviar varios objetos, ConvertTo-Xml devuelve un único documento XML en memoria que incluye representaciones de todos los objetos.

Este cmdlet es similar a export-Clixml excepto que Export-Clixml almacena el XML resultante en un archivo common Language Infrastructure (CLI) de que se puede volver a importar como objetos con Import-Clixml. ConvertTo-Xml devuelve una representación en memoria de un documento XML, por lo que puede seguir procesándolo en PowerShell. ConvertTo-Xml no tiene una opción para convertir objetos a XML de la CLI.

Ejemplos

Ejemplo 1: Conversión de una fecha a XML

Get-Date | ConvertTo-Xml

Este comando convierte la fecha actual (un objeto DateTime) en XML.

Ejemplo 2: Conversión de procesos a XML

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

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

Parámetros

-As

Determina el formato de salida. Los valores aceptables para este parámetro son:

  • String: devuelve una sola cadena.
  • Stream: devuelve una matriz de cadenas.
  • Document: devuelve un objeto XmlDocument.

El valor predeterminado es Document.

Tipo:String
Valores aceptados:Stream, String, Document
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Depth

Especifica cuántos niveles de objetos contenidos se incluyen 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.

Tipo:Int32
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-InputObject

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

Tipo:PSObject
Posición:0
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-NoTypeInformation

Omite el atributo Type de los nodos de objeto.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

Entradas

PSObject

Puede canalizar cualquier objeto a este cmdlet.

Salidas

String

Cuando se usa el parámetro As y se establece el valor en string, este cmdlet devuelve el XML como una cadena. Cuando el valor es stream, este cmdlet devuelve una matriz de cadenas.

XmlDocument

De forma predeterminada, este cmdlet devuelve un documento XML.