ConvertTo-Xml

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Cria uma representação baseada em XML de um objeto.

Syntax

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

Description

O ConvertTo-Xml cmdlet cria uma representação baseada em XML de um ou mais objetos .NET. Para utilizar este cmdlet, encaminhe um ou mais objetos para o cmdlet ou utilize o parâmetro InputObject para especificar o objeto.

Quando encaminha vários objetos para ConvertTo-Xml ou utiliza o parâmetro InputObject para submeter múltiplos objetos, ConvertTo-Xml devolve um único documento XML dentro da memória que inclui representações de todos os objetos.

Este cmdlet é semelhante a Export-Clixml , exceto que Export-Clixml armazena o XML resultante num ficheiro de Infraestrutura de Linguagem Comum (CLI) que pode ser reimportado como objetos com Import-Clixml. ConvertTo-Xml devolve uma representação dentro da memória de um documento XML, para que possa continuar a processá-lo no PowerShell. ConvertTo-Xml não tem uma opção para converter objetos em XML da CLI.

Exemplos

Exemplo 1: Converter uma data em XML

Get-Date | ConvertTo-Xml

Este comando converte a data atual (um objeto DateTime ) em XML.

Exemplo 2: Converter processos em XML

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

Este comando converte os objetos de processo que representam todos os processos no computador num documento XML. Os objetos são expandidos para uma profundidade de três níveis.

Parâmetros

-As

Determina o formato de saída. Os valores aceitáveis para este parâmetro são:

  • String - Devolve uma única cadeia.
  • Stream - Devolve uma matriz de cadeias.
  • Document - Devolve um objeto XmlDocument .

O valor predefinido é Document.

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

-Depth

Especifica quantos níveis de objetos contidos estão incluídos na representação XML. O valor predefinido é 1.

Por exemplo, se as propriedades do objeto também contiverem objetos, para guardar uma representação XML das propriedades dos objetos contidos, tem de especificar uma profundidade de 2.

O valor predefinido pode ser substituído para o tipo de objeto nos ficheiros Types.ps1xml. Para obter mais informações, consulte about_Types.ps1xml.

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

-InputObject

Especifica o objeto a converter. Introduza uma variável que contenha os objetos ou escreva um comando ou expressão que obtenha os objetos. Também pode encaminhar objetos para ConvertTo-XML.

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

-NoTypeInformation

Omite o atributo Tipo dos nós de objeto.

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

Entradas

PSObject

Pode encaminhar qualquer objeto para este cmdlet

Saídas

String

Quando utiliza o parâmetro Como e define o valor como string, este cmdlet devolve o XML como uma cadeia. Quando o valor for stream, este cmdlet devolve uma matriz de cadeias.

XmlDocument

Por predefinição, este cmdlet devolve um documento XML.