ForEach-Object

Référence

Module:: Microsoft.PowerShell.Core

Effectue une opération sur chaque élément d'une collection d'objets d'entrée.

Syntax

ForEach-Object
            [-InputObject <PSObject>]
            [-Begin <ScriptBlock>]
            [-Process] <ScriptBlock[]>
            [-End <ScriptBlock>]
            [-RemainingScripts <ScriptBlock[]>]
            [-WhatIf]
            [-Confirm]
            [<CommonParameters>]

ForEach-Object
            [-InputObject <PSObject>]
            [-MemberName] <String>
            [-ArgumentList <Object[]>]
            [-WhatIf]
            [-Confirm]
            [<CommonParameters>]

Description

L’applet ForEach-Object de commande effectue une opération sur chaque élément d’une collection d’objets d’entrée. Les objets d’entrée peuvent être redirigés vers l’applet de commande ou spécifiés à l’aide du paramètre InputObject .

À compter de Windows PowerShell 3.0, il existe deux façons différentes de construire une ForEach-Object commande.

Bloc de script. Vous pouvez utiliser un bloc de script pour spécifier l'opération. Dans le bloc de script, utilisez la $_ variable pour représenter l’objet actuel. Le bloc de script est la valeur du paramètre Process. Le bloc de script peut contenir n’importe quel script PowerShell.

Par exemple, la commande suivante obtient la valeur de la propriété ProcessName de chaque processus sur l'ordinateur.

Get-Process | ForEach-Object {$_.ProcessName}

ForEach-Object prend en charge les beginblocs , processet end les blocs comme décrit dans about_functions.

Notes

Les blocs de script s’exécutent dans l’étendue de l’appelant. Par conséquent, les blocs ont accès aux variables de cette étendue et peuvent créer de nouvelles variables qui persistent dans cette étendue une fois l’applet de commande terminée.
Instruction Operation. Vous pouvez également écrire une instruction d’opération, qui est beaucoup plus semblable au langage naturel. Vous pouvez utiliser l'instruction d'opération pour spécifier une valeur de propriété ou appeler une méthode. Les instructions d'opération ont été introduites dans Windows PowerShell 3.0.

Par exemple, la commande suivante obtient également la valeur de la propriété ProcessName de chaque processus sur l'ordinateur.

Get-Process | ForEach-Object ProcessName

Exemples

Exemple 1 : Diviser des entiers dans un tableau

Cet exemple prend un tableau de trois entiers et divise chacun d’eux par 1024.

30000, 56798, 12432 | ForEach-Object -Process {$_/1024}

29.296875
55.466796875
12.140625

Exemple 2 : Obtenir la longueur de tous les fichiers d’un répertoire

Cet exemple traite les fichiers et répertoires dans le répertoire $PSHOMEd’installation de PowerShell.

Get-ChildItem $PSHOME |
  ForEach-Object -Process {if (!$_.PSIsContainer) {$_.Name; $_.Length / 1024; " " }}

Si l’objet n’est pas un répertoire, le bloc de script obtient le nom du fichier, divise la valeur de sa propriété Length par 1024 et ajoute un espace ( » « ) pour le séparer de l’entrée suivante. L’applet de commande utilise la propriété PSISContainer pour déterminer si un objet est un répertoire.

Exemple 3 : Utiliser les événements système les plus récents

Cet exemple écrit les 1 000 événements les plus récents du journal des événements système dans un fichier texte. L’heure actuelle s’affiche avant et après le traitement des événements.

$Events = Get-EventLog -LogName System -Newest 1000
$events | ForEach-Object -Begin {Get-Date} -Process {Out-File -FilePath Events.txt -Append -InputObject $_.Message} -End {Get-Date}

Get-EventLog obtient les 1 000 événements les plus récents du journal des événements système et les stocke dans la $Events variable. $Events est ensuite redirigé vers l’applet de ForEach-Object commande. Le paramètre Begin affiche la date et l'heure actuelles. Ensuite, le paramètre Process utilise l’applet Out-File de commande pour créer un fichier texte nommé events.txt et stocke la propriété de message de chacun des événements de ce fichier. Enfin, le paramètre End est utilisé pour afficher la date et l'heure une fois l'ensemble du traitement terminé.

Exemple 4 : Modifier la valeur d’une clé de Registre

Cet exemple montre comment modifier la valeur de l’entrée de Registre RemotePath dans toutes les sous-clés sous la HKCU:\Network clé en texte majuscule.

Get-ItemProperty -Path HKCU:\Network\* |
  ForEach-Object {Set-ItemProperty -Path $_.PSPath -Name RemotePath -Value $_.RemotePath.ToUpper();}

Vous pouvez utiliser ce format pour modifier la forme ou le contenu d'une valeur d'entrée de Registre.

Chaque sous-clé de la clé Network représente un lecteur réseau mappé qui se reconnectera à l'ouverture de session. L'entrée RemotePath contient le chemin d'accès UNC du lecteur connecté. Par exemple, si vous mappez le lecteur \\Server\ShareE: , il y aura une sous-clé E et HKCU:\Network la valeur de l’entrée de Registre RemotePath dans la sous-clé E est \\Server\Share.

La commande utilise l’applet Get-ItemProperty de commande pour obtenir toutes les sous-clés de la clé réseau et l’applet Set-ItemProperty de commande pour modifier la valeur de l’entrée de Registre RemotePath dans chaque clé. Dans la Set-ItemProperty commande, le chemin d’accès est la valeur de la propriété PSPath de la clé de Registre. Il s’agit d’une propriété de l’objet Microsoft .NET Framework qui représente la clé de Registre, et non une entrée de Registre. La commande utilise la méthode ToUpper() de la valeur RemotePath , qui est une chaîne (REG_SZ).

Étant donné que Set-ItemProperty la modification de la propriété de chaque clé est nécessaire, l’applet ForEach-Object de commande doit accéder à la propriété.

Exemple 5 : Utiliser la variable automatique $Null

Cet exemple montre l’effet de la redirection de la $Null variable automatique vers l’applet ForEach-Object de commande.

1, 2, $null, 4 | ForEach-Object {"Hello"}

Hello
Hello
Hello
Hello

Étant donné que PowerShell traite null comme un espace réservé explicite, l’applet ForEach-Object de commande génère une valeur pour $Null, comme pour les autres objets que vous dirigez vers celui-ci.

Exemple 6 : Obtenir des valeurs de propriété

Cet exemple obtient la valeur de la propriété Path de tous les modules PowerShell installés à l’aide du paramètre MemberName de l’applet ForEach-Object de commande.

Get-Module -ListAvailable | ForEach-Object -MemberName Path
Get-Module -ListAvailable | Foreach Path

La deuxième commande est équivalente à la première. Il utilise l’alias Foreach de l’applet ForEach-Object de commande et omet le nom du paramètre MemberName , qui est facultatif.

L’applet ForEach-Object de commande est très utile pour obtenir des valeurs de propriété, car elle obtient la valeur sans modifier le type, contrairement aux applets de commande Format ou à l’applet Select-Object de commande, qui modifient le type de valeur de propriété.

Exemple 7 : Fractionner les noms de modules en noms de composants

Cet exemple montre trois façons de fractionner deux noms de modules séparés par des points en noms de composants.

"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" | ForEach-Object {$_.Split(".")}
"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" | ForEach-Object -MemberName Split -ArgumentList "."
"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" | Foreach Split "."

Microsoft
PowerShell
Core
Microsoft
PowerShell
Host

Elles appellent la méthode Split de chaînes. Les trois commandes utilisent une syntaxe différente, mais elles sont équivalentes et interchangeables.

La première commande utilise la syntaxe traditionnelle, qui inclut un bloc de script et l’opérateur $_d’objet actuel. Elle utilise la syntaxe à point pour spécifier la méthode et des parenthèses pour encadrer l'argument délimiteur.

La deuxième commande utilise le paramètre MemberName pour spécifier la méthode Split et le paramètre ArgumentName pour identifier le point (« . ») comme délimiteur de fractionnement.

La troisième commande utilise l’alias Foreach de l’applet ForEach-Object de commande et omet les noms des paramètres MemberName et ArgumentList , qui sont facultatifs.

Exemple 8 : Utilisation de ForEach-Object avec deux blocs de script

Dans cet exemple, nous passons deux blocs de script positionnels. Tous les blocs de script sont liés au paramètre Process . Toutefois, ils sont traités comme s’ils avaient été passés aux paramètres Begin et Process .

1..2 | ForEach-Object { 'begin' } { 'process' }

begin
process
process

Exemple 9 : Utilisation de ForEach-Object avec plus de deux blocs de script

1..2 | ForEach-Object { 'begin' } { 'process A' }  { 'process B' }  { 'end' }

begin
process A
process B
process A
process B
end

Notes

Le premier bloc de script est toujours mappé au begin bloc, le dernier bloc est mappé au end bloc et les blocs entre ces blocs sont tous mappés au process bloc.

Exemple 10 : Exécuter plusieurs blocs de script pour chaque élément de pipeline

Comme indiqué dans l’exemple précédent, plusieurs blocs de script passés à l’aide du paramètre Process sont mappés aux paramètres Begin et End . Pour éviter ce mappage, vous devez fournir des valeurs explicites pour les paramètres Begin et End .

1..2 | ForEach-Object -Begin $null -Process { 'one' }, { 'two' }, { 'three' } -End $null

one
two
three
one
two
three

Paramètres

-ArgumentList

Spécifie un tableau d’arguments à un appel de méthode. Pour plus d’informations sur le comportement d’ArgumentList, consultez about_Splatting.

Ce paramètre a été introduit dans Windows PowerShell 3.0.

Type:	Object[]
Aliases:	Args
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Begin

Spécifie un bloc de script qui s’exécute avant que cette applet de commande traite tous les objets d’entrée. Ce bloc de script n’est exécuté qu’une seule fois pour l’ensemble du pipeline. Pour plus d’informations sur le begin bloc, consultez about_Functions.

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

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

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

-End

Spécifie un bloc de script qui s’exécute après que cette applet de commande traite tous les objets d’entrée. Ce bloc de script n’est exécuté qu’une seule fois pour l’ensemble du pipeline. Pour plus d’informations sur le end bloc, consultez about_Functions.

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

-InputObject

Spécifie les objets d'entrée. ForEach-Object exécute l’instruction de bloc de script ou d’opération sur chaque objet d’entrée. Entrez une variable contenant les objets, ou tapez une commande ou une expression qui obtient ces objets.

Lorsque vous utilisez le paramètre InputObject avec ForEach-Object, au lieu de faire passer les résultats de la commande à ForEach-Object, la valeur InputObject est traitée comme un objet unique. Cela est vrai même si la valeur est une collection qui est le résultat d’une commande, telle que -InputObject (Get-Process). Comme InputObject ne peut pas retourner des propriétés individuelles à partir d’un tableau ou d’une collection d’objets, nous vous ForEach-Object recommandons de procéder à des opérations sur une collection d’objets pour ces objets qui ont des valeurs spécifiques dans des propriétés définies, que vous utilisez ForEach-Object dans le pipeline, comme illustré dans les exemples de cette rubrique.

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

-MemberName

Spécifie la propriété à obtenir ou la méthode à appeler.

Les caractères génériques sont autorisés, mais fonctionnent uniquement si la chaîne résultante est résolue en une valeur unique. Si, par exemple, vous exécutez Get-Process | ForEach -MemberName *Nameet que plusieurs membres existent avec un nom qui contient le nom de chaîne, tel que les propriétés ProcessName et Name , la commande échoue.

Ce paramètre a été introduit dans Windows PowerShell 3.0.

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

-Process

Spécifie l'opération qui est effectuée sur chaque objet d'entrée. Ce bloc de script est exécuté pour chaque objet du pipeline. Pour plus d’informations sur le process bloc, consultez about_Functions.

Lorsque vous fournissez plusieurs blocs de script au paramètre Process , le premier bloc de script est toujours mappé au begin bloc. S’il n’y a que deux blocs de script, le deuxième bloc est mappé au process bloc. S’il existe trois blocs de script ou plus, le premier bloc de script est toujours mappé au begin bloc, le dernier bloc est mappé au end bloc et les blocs entre ceux-ci sont tous mappés au process bloc.

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

-RemainingScripts

Spécifie tous les blocs de script qui ne sont pas pris par le paramètre Process .

Ce paramètre a été introduit dans Windows PowerShell 3.0.

Type:	ScriptBlock[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

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

Entrées

PSObject

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

Sorties

PSObject

Cette applet de commande retourne des objets déterminés par l’entrée.

Notes

L’applet ForEach-Object de commande fonctionne beaucoup comme l’instruction Foreach , sauf que vous ne pouvez pas diriger l’entrée vers une instruction Foreach . Pour plus d’informations sur l’instruction Foreach , consultez about_Foreach.
À compter de PowerShell 4.0, Where les ForEach méthodes ont été ajoutées pour une utilisation avec des collections. Vous pouvez en savoir plus sur ces nouvelles méthodes ici about_arrays

ForEach-Object

Syntax

Description

Exemples

Exemple 1 : Diviser des entiers dans un tableau

Exemple 2 : Obtenir la longueur de tous les fichiers d’un répertoire

Exemple 3 : Utiliser les événements système les plus récents

Exemple 4 : Modifier la valeur d’une clé de Registre

Exemple 5 : Utiliser la variable automatique $Null

Exemple 6 : Obtenir des valeurs de propriété

Exemple 7 : Fractionner les noms de modules en noms de composants

Exemple 8 : Utilisation de ForEach-Object avec deux blocs de script

Exemple 9 : Utilisation de ForEach-Object avec plus de deux blocs de script

Exemple 10 : Exécuter plusieurs blocs de script pour chaque élément de pipeline

Paramètres

-ArgumentList

-Begin

-Confirm

-End

-InputObject

-MemberName

-Process

-RemainingScripts

-WhatIf

Entrées

Sorties

Notes

Liens associés

Ressources supplémentaires