Compartilhar via

Format-List

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

Formata a saída como uma lista de propriedades na qual cada propriedade aparece em uma nova linha.

Syntax

Format-List
      [[-Property] <Object[]>]
      [-GroupBy <Object>]
      [-View <string>]
      [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <string>]
      [-InputObject <psobject>]
      [<CommonParameters>]

Description

O Format-List cmdlet formata a saída de um comando como uma lista de propriedades nas quais cada propriedade é exibida em uma linha separada. Você pode usar Format-List para formatar e exibir todas as propriedades ou propriedades selecionadas de um objeto como uma lista (Format-List -Property *).

Como há mais espaço disponível para cada item em uma lista do que em uma tabela, o PowerShell exibe mais propriedades do objeto na lista e os valores de propriedade são menos propensos a serem truncados.

Exemplos

Exemplo 1: Formatar serviços de computador

Get-Service | Format-List

Esse comando formata informações sobre os serviços no computador como uma lista. Por padrão, os serviços são formatados como uma tabela. O Get-Service cmdlet obtém objetos que representam os serviços no computador. O operador de pipeline (|) passa os resultados por meio do pipeline para Format-List. Em seguida, o Format-List comando formata as informações de serviço em uma lista e as envia para o cmdlet de saída padrão para exibição.

Exemplo 2: formatar arquivos PS1XML

Esses comandos exibem informações sobre os arquivos PS1XML no diretório do PowerShell como uma lista.

$A = Get-ChildItem $pshome\*.ps1xml
Format-List -InputObject $A

O primeiro comando obtém os objetos que representam os arquivos e os armazena na $A variável .

O segundo comando usa Format-List para formatar informações sobre objetos armazenados em $A. Esse comando usa o parâmetro InputObject para passar a variável para Format-List, que envia a saída formatada para o cmdlet de saída padrão para exibição.

Exemplo 3: Formatar propriedades do processo por nome

Este comando exibe o nome, a prioridade básica e a classe de prioridade de cada processo no computador.

Get-Process | Format-List -Property Name, BasePriority, PriorityClass

Ele usa o Get-Process cmdlet para obter um objeto que representa cada processo. O operador de pipeline (|) passa os objetos de processo por meio do pipeline para Format-List. Format-List formata os processos como uma lista das propriedades especificadas. O nome do parâmetro Property é opcional, portanto, você pode omitê-lo.

Exemplo 4: formatar todas as propriedades para um processo

Esse comando exibe todas as propriedades do processo winlogon.

Get-Process winlogon | Format-List -Property *

Ele usa o cmdlet Get-Process para obter um objeto que representa o processo do Winlogon. O operador de pipeline (|) passa o objeto de processo winlogon por meio do pipeline para Format-List. O comando usa o parâmetro Property para especificar as propriedades e o * para indicar todas as propriedades. Como o nome do parâmetro Property é opcional, você pode omitê-lo e digitar o comando como Format-List *. Format-List envia automaticamente os resultados para o cmdlet de saída padrão para exibição.

Exemplo 5: Solução de problemas de erros de formato

Os exemplos a seguir mostram os resultados da adição dos parâmetros DisplayError ou ShowError com uma expressão.

PC /> Get-Date | Format-List DayOfWeek,{ $_ / $null } -DisplayError

DayOfWeek    : Friday
 $_ / $null  : #ERR

PC /> Get-Date | Format-List DayOfWeek,{ $_ / $null } -ShowError

DayOfWeek    : Friday
 $_ / $null  :

Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 7:59:23 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

Parâmetros

-DisplayError

Indica que esse cmdlet exibe erros na linha de comando. Esse parâmetro raramente é usado, mas pode ser usado como um auxílio de depuração quando você está formatando expressões em um Format-List comando e as expressões não parecem estar funcionando.

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

-Expand

Especifica o objeto de coleção formatado, bem como os objetos na coleção. Esse parâmetro foi projetado para formatar objetos que dão suporte à interface System.Collections.ICollection . O valor padrão é EnumOnly. Os valores aceitáveis para esse parâmetro são:

  • EnumOnly. Exibe as propriedades dos objetos contidos na coleção.
  • CoreOnly. Exibe as propriedades do objeto da coleção.
  • Both. Exibe as propriedades do objeto da coleção e também as propriedades dos objetos contidos na coleção.
Type:String
Accepted values:CoreOnly, EnumOnly, Both
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indica que esse cmdlet exibe todas as informações de erro. Use com o parâmetro DisplayError ou ShowError . Por padrão, quando um objeto de erro é gravado nos fluxos de erro ou de exibição, apenas algumas informações de erro são exibidas.

Também é necessário ao formatar determinados tipos .NET. Para obter mais informações, veja a seção Observações.

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

-GroupBy

Especifica a saída em grupos com base em uma propriedade ou valor compartilhado. Insira uma expressão ou uma propriedade da saída.

O valor do parâmetro GroupBy pode ser uma nova propriedade calculada. A propriedade calculada pode ser um bloco de script ou uma tabela de hash. Pares chave-valor válidos são:

  • Name (ou Label) - <string>
  • Expression - <string> ou <script block>
  • FormatString - <string>

Para obter mais informações, consulte about_Calculated_Properties.

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

-InputObject

Especifica os objetos a serem formatados. Insira uma variável que contém os objetos ou digite um comando ou uma expressão que obtém os objetos.

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

-Property

Especifica as propriedades do objeto que aparecem na exibição e a ordem em que aparecem. Caracteres curinga são permitidos.

Se você omitir esse parâmetro, as propriedades a serem exibidas dependerão do objeto sendo exibido. O nome do parâmetro Propriedade é opcional. Não é possível usar os parâmetros Propriedade e Exibição no mesmo comando.

O valor do parâmetro Property pode ser uma nova propriedade calculada. A propriedade calculada pode ser um bloco de script ou uma tabela de hash. Pares chave-valor válidos são:

  • Name (ou Label) - <string>
  • Expression - <string> ou <script block>
  • FormatString - <string>

Para obter mais informações, consulte about_Calculated_Properties.

Type:Object[]
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowError

Indica que o cmdlet envia erros por meio do pipeline. Esse parâmetro raramente é usado, mas pode ser usado como um auxílio de depuração quando você está formatando expressões em um Format-List comando e as expressões não parecem estar funcionando.

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

-View

Especifica o nome de um formato ou exibição de lista alternativo. Não é possível usar os parâmetros Propriedade e Exibição no mesmo comando.

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

Entradas

PSObject

Você pode redirecionar qualquer objeto para este cmdlet.

Saídas

Microsoft.PowerShell.Commands.Internal.Format

Esse cmdlet retorna os objetos de formato que representam a lista.

Observações

O PowerShell inclui os seguintes aliases para Format-List:

  • Todas as plataformas:
    • fl

Os cmdlets de formato, como Format-List, organizam os dados a serem exibidos, mas não os exibem. Os dados são exibidos pelos recursos de saída do PowerShell e pelos cmdlets que contêm o Out verbo (os Out cmdlets), como Out-Host ou Out-File.

Se você não usar um cmdlet de formato, o PowerShell aplicará esse formato padrão para cada objeto exibido.

O parâmetro GroupBy pressupõe que os objetos sejam classificados. Use antes de Sort-Object usar Format-List para agrupar os objetos.

O parâmetro View permite especificar um formato alternativo para a tabela. Você pode usar as exibições definidas nos *.format.PS1XML arquivos no diretório do PowerShell ou criar seus próprios modos de exibição em novos arquivos PS1XML e usar o Update-FormatData cmdlet para incluí-los no PowerShell.

A exibição alternativa para o parâmetro View deve usar o formato de lista, caso contrário, o comando falhará. Se a exibição alternativa for uma tabela, use Format-Table. Se a exibição alternativa não for uma lista ou uma tabela, use Format-Custom.

Se você quiser usar Format-List com o parâmetro Property , precisará incluir o parâmetro Force em qualquer uma das seguintes condições: