Partilhar via

ConvertTo-Xml

Módulo:
Microsoft.PowerShell.Utility Module

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

Sintaxe

Default (Predefinição) 

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

Description

O cmdlet cria uma representação baseada em XML de um ou mais objetos .NET. 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, ConvertTo-Xml retorna um único documento XML na memória que inclui representações de todos os objetos.

Este cmdlet é semelhante a Export-Clixml, exceto que armazena o XML resultante em um arquivo Common Language Infrastructure (CLI) que pode ser reimportado como objetos com Import-Clixml. ConvertTo-Xml retorna uma representação na memória de um documento XML, para que você 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 em um 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 de caracteres.
  • Stream - Devolve uma matriz de cadeias de caracteres.
  • - Retorna um objeto XmlDocument .

O valor predefinido é Document.

Propriedades dos parâmetros

Tipo:String
Default value:None
Valores aceites:Stream, String, Document
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Depth

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.

Propriedades dos parâmetros

Tipo:Int32
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-InputObject

Especifica o objeto a ser convertido. Insira uma variável que contenha os objetos ou digite um comando ou expressão que obtenha os objetos. Você também pode canalizar objetos para ConvertTo-Xml.

Propriedades dos parâmetros

Tipo:PSObject
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-NoTypeInformation

Omite o atributo Tipo dos nós do objeto.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSObject

Você pode canalizar qualquer objeto para este cmdlet

Saídas

String

Quando você usa o parâmetro As e define o valor como string, esse cmdlet retorna o XML como uma cadeia de caracteres. Quando o valor é stream, esse cmdlet retorna uma matriz de cadeias de caracteres.

XmlDocument

Por padrão, esse cmdlet retorna um documento XML.