Compartir a través de

ConvertTo-Xml

Módulo:
Microsoft.PowerShell.Utility Module

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

Sintaxis

Default (valor predeterminado) 

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

Description

El 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 se canalizan varios objetos o ConvertTo-Xml se usa el parámetro InputObject para enviar varios objetos, ConvertTo-Xml se 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 XML 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ándolo en PowerShell. ConvertTo-Xml no tiene una opción para convertir objetos a XML de 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.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Valores aceptados:Stream, String, Document
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes: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.

Propiedades de parámetro

Tipo:Int32
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes: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 redirigir objetos a ConvertTo-XML.

Propiedades de parámetro

Tipo:PSObject
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-NoTypeInformation

Omite el atributo Type de los nodos de objeto.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

PSObject

Puede canalizar cualquier objeto a ConvertTo-XML.

Salidas

System.String or System.Xml.XmlDocument

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