Format-List

  • Référence
Module:
Microsoft.PowerShell.Utility

Organise la sortie sous la forme d'une liste de propriétés dont chaque élément apparaît sur sa propre ligne.

Syntaxe

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

Description

L’applet Format-List de commande met en forme la sortie d’une commande sous la forme d’une liste de propriétés dans laquelle chaque propriété est affichée sur une ligne distincte. Vous pouvez utiliser Format-List pour mettre en forme et afficher toutes les propriétés ou les propriétés sélectionnées d’un objet sous forme de liste (Format-List -Property *).

Étant donné que plus d’espace est disponible pour chaque élément d’une liste que dans une table, PowerShell affiche plus de propriétés de l’objet dans la liste et les valeurs de propriété sont moins susceptibles d’être tronquées.

Exemples

Exemple 1 : Mettre en forme les services d’ordinateur

Get-Service | Format-List

Cette commande met en forme des informations sur des services sur l'ordinateur sous forme de liste. Par défaut, les services sont mis en forme en tant que table. L’applet Get-Service de commande obtient des objets représentant les services sur l’ordinateur. L’opérateur de pipeline (|) transmet les résultats via le pipeline à Format-List. Ensuite, la Format-List commande met en forme les informations de service dans une liste et les envoie à l’applet de commande de sortie par défaut pour l’affichage.

Exemple 2 : Mettre en forme des fichiers PS1XML

Ces commandes affichent des informations sur les fichiers PS1XML dans le répertoire PowerShell sous forme de liste.

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

La première commande obtient les objets représentant les fichiers et les stocke dans la $A variable.

La deuxième commande utilise Format-List pour mettre en forme des informations sur les objets stockés dans $A. Cette commande utilise le paramètre InputObject pour transmettre la variable à Format-List, qui envoie ensuite la sortie mise en forme à l’applet de commande de sortie par défaut pour l’affichage.

Exemple 3 : Mettre en forme les propriétés du processus par nom

Cette commande affiche le nom, la priorité de base et la classe de priorité de chaque processus sur l'ordinateur.

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

Il utilise l’applet Get-Process de commande pour obtenir un objet représentant chaque processus. L’opérateur de pipeline (|) transmet les objets de processus via le pipeline à Format-List. Format-List met en forme les processus sous forme de liste des propriétés spécifiées. Le nom du paramètre Property est facultatif. Vous pouvez donc l’omettre.

Exemple 4 : Mettre en forme toutes les propriétés d’un processus

Cette commande affiche toutes les propriétés du processus Winlogon.

Get-Process winlogon | Format-List -Property *

Elle utilise l'applet de commande Get-Process pour obtenir un objet représentant le processus Winlogon. L’opérateur de pipeline (|) transmet l’objet de processus Winlogon à .Format-List La commande utilise le paramètre Property pour spécifier les propriétés et pour * indiquer toutes les propriétés. Étant donné que le nom du paramètre Property est facultatif, vous pouvez l’omettre et taper la commande en tant que Format-List *. Format-List envoie automatiquement les résultats à l’applet de commande de sortie par défaut pour l’affichage.

Exemple 5 : Résolution des erreurs de format

Les exemples suivants montrent les résultats de l’ajout des paramètres DisplayError ou ShowError avec une expression.

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

Paramètres

-DisplayError

Indique que cette applet de commande affiche des erreurs sur la ligne de commande. Ce paramètre est rarement utilisé, mais peut être utilisé comme aide de débogage lorsque vous mettez en forme des expressions dans une Format-List commande et que les expressions ne semblent pas fonctionner.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Expand

Spécifie l’objet de collection mis en forme, ainsi que les objets de la collection. Ce paramètre est conçu pour mettre en forme des objets qui prennent en charge l’interface System.Collections.ICollection . La valeur par défaut est EnumOnly. Les valeurs valides pour ce paramètre sont :

  • EnumOnly. Affiche les propriétés des objets dans la collection.
  • CoreOnly. Affiche les propriétés de l'objet de collection.
  • Both. Affiche les propriétés de l'objet de collection et les propriétés des objets contenus dans la collection.
Type:String
Valeurs acceptées:CoreOnly, EnumOnly, Both
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Force

Indique que cette applet de commande affiche toutes les informations d’erreur. Utiliser avec le paramètre DisplayError ou ShowError . Par défaut, lorsqu’un objet d’erreur est écrit dans les flux d’erreur ou d’affichage, seules certaines informations d’erreur sont affichées.

Obligatoire également lors de la mise en forme de certains types .NET. Pour plus d’informations, consultez la section Remarques.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-GroupBy

Spécifie la sortie dans les groupes en fonction d’une propriété ou d’une valeur partagée. Entrez une expression ou une propriété de la sortie.

La valeur du paramètre GroupBy peut être une nouvelle propriété calculée. La propriété calculée peut être un bloc de script ou une table de hachage. Les paires clé-valeur valides sont les suivantes :

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

Pour plus d’informations, consultez about_Calculated_Properties.

Type:Object
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-InputObject

Spécifie les objets à mettre en forme. Entrez une variable contenant les objets, ou tapez une commande ou une expression qui les obtient.

Type:PSObject
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Property

Spécifie les propriétés d'objet qui apparaissent dans l''affichage et l'ordre dans lequel elles apparaissent. Les caractères génériques sont autorisés.

Si vous omettez ce paramètre, les propriétés qui apparaissent dans l'affichage dépendent de l'objet affiché. La propriété du nom de paramètre est facultative. Vous ne pouvez pas utiliser les paramètres Propriété et Affichage dans la même commande.

La valeur du paramètre Property peut être une nouvelle propriété calculée. La propriété calculée peut être un bloc de script ou une table de hachage. Les paires clé-valeur valides sont les suivantes :

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

Pour plus d’informations, consultez about_Calculated_Properties.

Type:Object[]
Position:0
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:True

-ShowError

Indique que l’applet de commande envoie des erreurs via le pipeline. Ce paramètre est rarement utilisé, mais peut être utilisé comme aide de débogage lorsque vous mettez en forme des expressions dans une Format-List commande et que les expressions ne semblent pas fonctionner.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-View

Spécifie le nom d’un autre format de liste ou vue. Vous ne pouvez pas utiliser les paramètres Propriété et Affichage dans la même commande.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

PSObject

Vous pouvez diriger n’importe quel objet vers cette applet de commande.

Sorties

Microsoft.PowerShell.Commands.Internal.Format

Cette applet de commande retourne les objets de format qui représentent la liste.

Notes

PowerShell inclut les alias suivants pour Format-List:

  • Toutes les plateformes :
    • fl

Les applets de commande de format, telles que Format-List, organisent les données à afficher, mais ne l’affichent pas. Les données sont affichées par les fonctionnalités de sortie de PowerShell et par les applets de commande qui contiennent le Out verbe (les Out applets de commande), telles que Out-Host ou Out-File.

Si vous n’utilisez pas d’applet de commande de format, PowerShell applique ce format par défaut pour chaque objet qu’il affiche.

Le paramètre GroupBy suppose que les objets sont triés. Utilisez Sort-Object avant d’utiliser Format-List pour regrouper les objets.

Le paramètre View vous permet de spécifier un autre format pour le tableau. Vous pouvez utiliser les vues définies dans les *.format.PS1XML fichiers du répertoire PowerShell, ou vous pouvez créer vos propres vues dans de nouveaux fichiers PS1XML et utiliser l’applet Update-FormatData de commande pour les inclure dans PowerShell.

L’autre affichage du paramètre View doit utiliser le format de liste ; sinon, la commande échoue. Si l’autre vue est une table, utilisez Format-Table. Si l’affichage de remplacement n’est pas une liste ou une table, utilisez Format-Custom.

Si vous souhaitez utiliser Format-List avec le paramètre Property , vous devez inclure le paramètre Force dans l’une des conditions suivantes :