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

Sintaxe

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

Descrição

O cmdlet ConvertTo-Xml cria uma representação baseada em XML de um ou mais objetos do Microsoft .NET Framework. Para usar esse cmdlet, canalize um ou mais objetos para o cmdlet ou use o parâmetro InputObject para especificar o objeto.

Quando você canaliza vários objetos para ConvertTo-XML ou usa o parâmetro InputObject para enviar vários objetos, o ConvertTo-XML retorna um único documento XML que inclui representações de todos os objetos.

Esse cmdlet é semelhante ao Export-Clixml, exceto pelo fato de Export-Clixml armazenar o XML resultante em um arquivo. ConvertTo-XML retorna o XML, assim você pode continuar a processá-lo no Windows PowerShell.

Parâmetros

-As <string>

Determina o formato de saída. Os valores válidos são:

-- String: retorna uma única cadeia de caracteres.

-- Stream: retorna uma matriz de cadeias de caracteres.

-- Document: retorna um objeto XmlDocument.

Stream é o padrão.

Necessário?

false

Posição?

named

Valor padrão

Stream

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Depth <int>

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

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

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

Necessário?

false

Posição?

named

Valor padrão

1

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-InputObject <psobject>

Especifica o objeto a ser convertido. Insira uma variável que contenha os objetos ou digite um comando ou uma expressão que obtenha os objetos. Também é possível canalizar objetos para ConvertTo-XML.

Necessário?

true

Posição?

1

Valor padrão

nenhum

Aceitar entrada do pipeline?

true (ByValue)

Aceitar caracteres curinga?

true

-NoTypeInformation

Omite o atributo Type dos nós de objeto.

Necessário?

false

Posição?

named

Valor padrão

False

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Entradas

System.Management.Automation.PSObject

Você pode canalizar qualquer objeto para ConvertTo-XML.

Saídas

System.String ou System.Xml.XmlDocument

O valor do parâmetro determina o tipo de objeto que ConvertTo-XML retorna.

Exemplo 1

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

Descrição
-----------
Esse comando converte a data atual (um objeto DateTime) em XML.






Exemplo 2

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

Descrição
-----------
Esse comando converte os objetos de processo que representam todos os processos do computador em um documento XML. Os objetos são expandidos para uma profundidade de três níveis.






See Also




Sumário