ConvertTo-Xml

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

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

Syntax

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

Description

El ConvertTo-Xml cmdlet 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.

Cuando canaliza varios objetos a ConvertTo-Xml o usa 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 de Common Language Infrastructure (CLI) 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ándola 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 hasta una profundidad de tres niveles.

Parámetros

-As

Determina el formato de salida. Los valores permitidos para este parámetro son los siguientes:

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

El valor predeterminado es Document.

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

-Depth

Especifica el número de niveles de los 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 se 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, consulte about_Types.ps1xml.

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

-InputObject

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

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

-NoTypeInformation

Omite el atributo Type de los nodos de objeto.

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

Entradas

PSObject

Puede canalizar cualquier objeto a este cmdlet.

Salidas

String

Cuando se usa el parámetro As y se establece el valor stringen , 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.