ForEach-Object
Effectue une opération sur chaque élément d'une collection d'objets d'entrée.
Syntaxe
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>]
ForEach-Object
-Parallel <scriptblock>
[-InputObject <psobject>]
[-ThrottleLimit <int>]
[-TimeoutSeconds <int>]
[-AsJob]
[-UseNewRunspace]
[-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 lesbegin
blocs,process
commeend
décrit dans about_functions.Remarque
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
Bloc de script en cours d’exécution parallèle. À compter de PowerShell 7.0, un troisième jeu de paramètres est disponible qui exécute chaque bloc de script en parallèle. Le paramètre ThrottleLimit limite le nombre de scripts parallèles en cours d’exécution à la fois. Comme précédemment, utilisez la
$_
variable pour représenter l’objet d’entrée actuel dans le bloc de script. Utilisez le$using:
mot clé pour passer des références de variables au script en cours d’exécution.Dans PowerShell 7, un nouvel espace d’exécution est créé pour chaque itération de boucle pour garantir l’isolation maximale. Il peut s’agir d’un impact important sur les performances et les ressources si le travail que vous effectuez est petit par rapport à la création de nouveaux espaces d’exécution ou s’il existe beaucoup d’itérations effectuant un travail significatif. À partir de PowerShell 7.1, les instances d’exécution d’un pool d’espaces de exécution sont réutilisées par défaut. Le paramètre ThrottleLimit définit la taille du pool d’instances d’exécution. La taille du pool runspace par défaut est 5. Vous pouvez toujours créer un espace d’exécution pour chaque itération à l’aide du commutateur UseNewRunspace .
Par défaut, les blocs de script parallèles utilisent le répertoire de travail actuel de l’appelant qui a démarré les tâches parallèles.
Pour plus d’informations, consultez la section NOTES de cet article.
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 les répertoires dans le répertoire $PSHOME
d’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.
Get-EventLog -LogName System -Newest 1000 |
ForEach-Object -Begin {Get-Date} -Process {
Out-File -FilePath Events.txt -Append -InputObject $_.Message
} -End {Get-Date}
Get-EventLog
obtient les 1000 événements les plus récents du journal des événements système et les canalise vers l’applet ForEach-Object
de 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 après la fin du traitement.
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 en majuscules.
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é réseau représente un lecteur réseau mappé qui se reconnecte lors de l’authentification. L’entrée RemotePath contient le chemin UNC du lecteur connecté. Par exemple, si vous mappez le E:
lecteur à \\Server\Share
, une sous-clé E est créée avec HKCU:\Network
la valeur de Registre RemotePath définie sur \\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 conversion de la $null
variable automatique à 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 comme $null
elle le fait pour d’autres objets redirigés 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 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 module en noms de composants
Cet exemple montre trois façons de fractionner deux noms de modules séparés par points en noms de composants. Les commandes appellent la méthode Split de chaînes. Les trois commandes utilisent une syntaxe différente, mais elles sont équivalentes et interchangeables. La sortie est la même pour les trois cas.
"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
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 ArgumentList pour identifier le point (.
) comme délimiteur fractionné.
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 en position position. 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
Dans cet exemple, nous passons quatre blocs de script en position position. 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, Process et End .
1..2 | ForEach-Object { 'begin' } { 'process A' } { 'process B' } { 'end' }
begin
process A
process B
process A
process B
end
Remarque
Le premier bloc de script est toujours mappé au begin
bloc, le dernier bloc est mappé au end
bloc et les deux blocs intermédiaires sont 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
Exemple 11 : Exécuter un script lent dans des lots parallèles
Cet exemple exécute un bloc de script qui évalue une chaîne et est en veille pendant une seconde.
$Message = "Output:"
1..8 | ForEach-Object -Parallel {
"$using:Message $_"
Start-Sleep 1
} -ThrottleLimit 4
Output: 1
Output: 2
Output: 3
Output: 4
Output: 5
Output: 6
Output: 7
Output: 8
La valeur du paramètre ThrottleLimit est définie sur 4 afin que l’entrée soit traitée par lots de quatre.
Le $using:
mot clé est utilisé pour passer la $Message
variable dans chaque bloc de script parallèle.
Exemple 12 : Récupérer des entrées de journal en parallèle
Cet exemple récupère 50 000 entrées de journal à partir de 5 journaux système sur un ordinateur Windows local.
$logNames = 'Security', 'Application', 'System', 'Windows PowerShell',
'Microsoft-Windows-Store/Operational'
$logEntries = $logNames | ForEach-Object -Parallel {
Get-WinEvent -LogName $_ -MaxEvents 10000
} -ThrottleLimit 5
$logEntries.Count
50000
Le paramètre Parallel spécifie le bloc de script exécuté en parallèle pour chaque nom de journal d’entrée. Le paramètre ThrottleLimit garantit que les cinq blocs de script s’exécutent en même temps.
Exemple 13 : Exécuter en parallèle en tant que travail
Cet exemple crée un travail qui exécute un bloc de script en parallèle, deux à la fois.
PS> $job = 1..10 | ForEach-Object -Parallel {
"Output: $_"
Start-Sleep 1
} -ThrottleLimit 2 -AsJob
PS> $job
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
23 Job23 PSTaskJob Running True PowerShell …
PS> $job.ChildJobs
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
24 Job24 PSTaskChildJob Completed True PowerShell …
25 Job25 PSTaskChildJob Completed True PowerShell …
26 Job26 PSTaskChildJob Running True PowerShell …
27 Job27 PSTaskChildJob Running True PowerShell …
28 Job28 PSTaskChildJob NotStarted False PowerShell …
29 Job29 PSTaskChildJob NotStarted False PowerShell …
30 Job30 PSTaskChildJob NotStarted False PowerShell …
31 Job31 PSTaskChildJob NotStarted False PowerShell …
32 Job32 PSTaskChildJob NotStarted False PowerShell …
33 Job33 PSTaskChildJob NotStarted False PowerShell …
Le paramètre ThrottleLimit limite le nombre de blocs de script parallèles en cours d’exécution à la fois. Le paramètre AsJob amène l’applet ForEach-Object
de commande à retourner un objet de travail au lieu de diffuser en continu la sortie vers la console. La $job
variable reçoit l’objet de travail qui collecte les données de sortie et surveille l’état en cours d’exécution. La $job.ChildJobs
propriété contient les travaux enfants qui exécutent les blocs de script parallèle.
Exemple 14 : Utilisation de références de variables thread safe
Cet exemple appelle des blocs de script en parallèle pour collecter des objets Process nommés de manière unique.
$threadSafeDictionary = [System.Collections.Concurrent.ConcurrentDictionary[string,object]]::new()
Get-Process | ForEach-Object -Parallel {
$dict = $using:threadSafeDictionary
$dict.TryAdd($_.ProcessName, $_)
}
$threadSafeDictionary["pwsh"]
NPM(K) PM(M) WS(M) CPU(s) Id SI ProcessName
------ ----- ----- ------ -- -- -----------
82 82.87 130.85 15.55 2808 2 pwsh
Une seule instance d’un objet ConcurrentDictionary est passée à chaque bloc de script pour collecter les objets. Étant donné que ConcurrentDictionary est thread safe, il est sûr d’être modifié par chaque script parallèle. Un objet non thread-safe, tel que System.Collections.Generic.Dictionary, ne serait pas sûr d’être utilisé ici.
Remarque
Cet exemple est une utilisation inefficace du paramètre Parallel . Le script ajoute l’objet d’entrée à un objet de dictionnaire simultané. Il est trivial et ne vaut pas la peine d’appeler chaque script dans un thread distinct. L’exécution ForEach-Object
sans commutateur parallèle est plus efficace et plus rapide. Cet exemple est destiné uniquement à montrer comment utiliser des variables thread safe.
Exemple 15 : Écriture d’erreurs avec exécution parallèle
Cet exemple écrit dans le flux d’erreurs en parallèle, où l’ordre des erreurs écrites est aléatoire.
1..3 | ForEach-Object -Parallel {
Write-Error "Error: $_"
}
Write-Error: Error: 1
Write-Error: Error: 3
Write-Error: Error: 2
Exemple 16 : Fin des erreurs dans l’exécution parallèle
Cet exemple illustre une erreur de fin dans un scriptblock en cours d’exécution parallèle.
1..5 | ForEach-Object -Parallel {
if ($_ -eq 3)
{
throw "Terminating Error: $_"
}
Write-Output "Output: $_"
}
Exception: Terminating Error: 3
Output: 1
Output: 4
Output: 2
Output: 5
Output: 3
n’est jamais écrit, car le scriptblock parallèle pour cette itération a été arrêté.
Remarque
Les variables de paramètre courantes PipelineVariable ne sont pas prises en charge dans Foreach-Object -Parallel
les scénarios même avec le $using:
mot clé.
Exemple 17 : Passage de variables dans un script parallèle imbriqué ScriptBlockSet
Vous pouvez créer une variable en dehors d’un Foreach-Object -Parallel
scriptblock délimité et l’utiliser à l’intérieur du scriptblock avec le $using
mot clé.
$test1 = 'TestA'
1..2 | Foreach-Object -Parallel {
$using:test1
}
TestA
TestA
# You CANNOT create a variable inside a scoped scriptblock
# to be used in a nested foreach parallel scriptblock.
$test1 = 'TestA'
1..2 | Foreach-Object -Parallel {
$using:test1
$test2 = 'TestB'
1..2 | Foreach-Object -Parallel {
$using:test2
}
}
Line |
2 | 1..2 | Foreach-Object -Parallel {
| ~~~~~~~~~~~~~~~~~~~~~~~~~~
| The value of the using variable '$using:test2' can't be retrieved because it has
| not been set in the local session.
Le scriptblock imbriqué ne peut pas accéder à la $test2
variable et une erreur est levée.
Exemple 18 : Création de plusieurs travaux qui exécutent des scripts en parallèle
Le paramètre ThrottleLimit limite le nombre de scripts parallèles en cours d’exécution pendant chaque instance de ForEach-Object -Parallel
. Elle ne limite pas le nombre de travaux qui peuvent être créés lors de l’utilisation du paramètre AsJob . Étant donné que les travaux eux-mêmes s’exécutent simultanément, il est possible de créer plusieurs travaux parallèles, chacun s’exécutant jusqu’au nombre limite de blocs de script simultanés.
$jobs = for ($i=0; $i -lt 10; $i++) {
1..10 | ForEach-Object -Parallel {
./RunMyScript.ps1
} -AsJob -ThrottleLimit 5
}
$jobs | Receive-Job -Wait
Cet exemple crée 10 travaux en cours d’exécution. Chaque travail n’exécute plus que 5 scripts simultanément. Le nombre total d’instances exécutées simultanément est limité à 50 (10 travaux fois la limite de 5).
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[] |
Alias: | Args |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-AsJob
Provoque l’exécution de l’appel parallèle en tant que travail PowerShell. Un objet de travail unique est retourné au lieu de la sortie des blocs de script en cours d’exécution. L’objet de travail contient des travaux enfants pour chaque bloc de script parallèle qui s’exécute. Vous pouvez utiliser l’objet de travail avec l’une des applets de commande de travail PowerShell pour afficher l’état en cours d’exécution et récupérer des données.
Ce paramètre a été introduit dans PowerShell 7.0.
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 |
-Begin
Spécifie un bloc de script qui s’exécute avant que cette applet de commande traite 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 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Confirm
Vous demande une confirmation avant d’exécuter l’applet de commande.
Type: | SwitchParameter |
Alias: | cf |
Position: | Named |
Valeur par défaut: | False |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | 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 |
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 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 passer aux ForEach-Object
résultats de la commande piping, la valeur InputObject est traitée comme un seul objet. 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 d’effectuer des opérations sur une collection d’objets pour ces objets qui ont des valeurs spécifiques dans les 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 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-MemberName
Spécifie le nom de la propriété membre à appeler ou la méthode membre à appeler. Les membres doivent être des membres d’instance, et non des membres statiques.
Les caractères génériques sont autorisés, mais fonctionnent uniquement si la chaîne résultante se résout en une valeur unique.
Par exemple, si vous exécutez Get-Process | ForEach -MemberName *Name
, le modèle générique correspond à plusieurs membres à l’origine de l’échec de la commande.
Ce paramètre a été introduit dans Windows PowerShell 3.0.
Type: | String |
Position: | 0 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | True |
-Parallel
Spécifie le bloc de script à utiliser pour le traitement parallèle des objets d’entrée. Entrez un bloc de script décrivant l'opération.
Ce paramètre a été introduit dans PowerShell 7.0.
Type: | ScriptBlock |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Process
Spécifie l’opération 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 intermédiaires sont mappés au process
bloc.
Type: | ScriptBlock[] |
Position: | 0 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | 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 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ThrottleLimit
Spécifie le nombre de blocs de script qui s’exécutent en parallèle. Les objets d’entrée sont bloqués jusqu’à ce que le nombre de blocs de script en cours d’exécution soit inférieur à la limite de limitation. La valeur par défaut est 5
.
Le paramètre ThrottleLimit limite le nombre de scripts parallèles en cours d’exécution pendant chaque instance de ForEach-Object -Parallel
. Elle ne limite pas le nombre de travaux qui peuvent être créés lors de l’utilisation du paramètre AsJob . Étant donné que les travaux eux-mêmes s’exécutent simultanément, il est possible de créer un certain nombre de travaux parallèles, chacun s’exécutant jusqu’au nombre limite de blocs de script simultanés.
Ce paramètre a été introduit dans PowerShell 7.0.
Type: | Int32 |
Position: | Named |
Valeur par défaut: | 5 |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-TimeoutSeconds
Spécifie le nombre de secondes à attendre que toutes les entrées soient traitées en parallèle. Après le délai d’expiration spécifié, tous les scripts en cours d’exécution sont arrêtés. Et tous les objets d’entrée restants à traiter sont ignorés. La valeur par défaut de 0
désactive le délai d’expiration et ForEach-Object -Parallel
peut s’exécuter indéfiniment. La saisie de Ctrl+C sur la ligne de commande arrête une commande en cours d’exécution.ForEach-Object -Parallel
Ce paramètre ne peut pas être utilisé avec le paramètre AsJob .
Ce paramètre a été introduit dans PowerShell 7.0.
Type: | Int32 |
Position: | Named |
Valeur par défaut: | 0 |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-UseNewRunspace
Provoque l’appel parallèle pour créer un espace d’exécution pour chaque itération de boucle au lieu de réutiliser les espaces d’exécution à partir du pool d’instances d’exécution.
Ce paramètre a été introduit dans PowerShell 7.1
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | False |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | 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 |
Alias: | wi |
Position: | Named |
Valeur par défaut: | False |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
Entrées
Vous pouvez diriger n’importe quel objet vers cette applet de commande.
Sorties
Cette applet de commande retourne des objets déterminés par l’entrée.
Notes
PowerShell inclut les alias suivants pour ForEach-Object
:
- Toutes les plateformes :
%
foreach
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
Utilisation de ForEach-Object -Parallel
:
ForEach-Object -Parallel
exécute chaque bloc de script dans un nouvel espace d’exécution. Les nouveaux espaces d’exécution créent beaucoup plus de surcharge que l’exécutionForEach-Object
avec un traitement séquentiel. Il est important d’utiliser Parallel où la surcharge d’exécution en parallèle est petite par rapport au travail effectué par le bloc de script. Par exemple :- Calcul de scripts intensifs sur des machines multicœurs
- Scripts qui passent du temps à attendre les résultats ou à effectuer des opérations de fichier
L’utilisation du paramètre Parallel peut entraîner l’exécution de scripts beaucoup plus lents que la normale. Surtout si les scripts parallèles sont trivials. Expérimentez avec Parallel pour découvrir où il peut être bénéfique.
Lors de l’exécution en parallèle, les objets décorés avec ScriptProperties ou ScriptMethods ne peuvent pas être garantis pour fonctionner correctement s’ils sont exécutés dans un espace d’exécution différent de celui des scripts qui leur ont été attachés à l’origine.
L’appel scriptblock tente toujours de s’exécuter dans son runspace d’accueil , quel que soit l’emplacement où il est réellement appelé. Toutefois,
ForEach-Object -Parallel
crée des runspaces temporaires qui sont supprimés après l’utilisation. Il n’existe donc plus d’espace d’exécution pour que les scripts s’exécutent plus.Ce comportement peut fonctionner tant que l’espace d’exécution d’accueil existe toujours. Toutefois, vous n’obtenez peut-être pas le résultat souhaité si le script dépend de variables externes uniquement présentes dans l’espace d’exécution de l’appelant et non dans l’espace d’exécution de l’appelant.
Les erreurs sans fin sont écrites dans le flux d’erreurs d’applet de commande lorsqu’elles se produisent dans des blocs de script en cours d’exécution parallèles. Étant donné que l’ordre d’exécution de scriptblock parallèle n’est pas déterministe, l’ordre dans lequel les erreurs apparaissent dans le flux d’erreurs est aléatoire. De même, les messages écrits dans d’autres flux de données, tels que l’avertissement, le verbe ou les informations, sont écrits dans ces flux de données dans un ordre indéterminé.
La fin des erreurs, telles que les exceptions, met fin à l’instance parallèle individuelle des blocs de script dans lesquels elles se produisent. Une erreur de fin dans un scriptblocks peut ne pas entraîner l’arrêt de l’applet
Foreach-Object
de commande. Les autres blocs de script, s’exécutant en parallèle, continuent à s’exécuter, sauf s’ils rencontrent également une erreur de fin. L’erreur de fin est écrite dans le flux de données d’erreur en tant que ErrorRecord avec un FullyQualifiedErrorId dePSTaskException
. Les erreurs de fin peuvent être converties en erreurs sans fin à l’aide de PowerShelltry
/catch
outrap
de blocs.Les variables de paramètre courantes PipelineVariable ne sont pas prises en charge dans les scénarios parallèles, même avec le
$using:
mot clé.Important
Le
ForEach-Object -Parallel
jeu de paramètres exécute des blocs de script en parallèle sur des threads de processus distincts. Le$using:
mot clé permet de transmettre des références de variables du thread d’appel d’applet de commande à chaque thread de bloc de script en cours d’exécution. Étant donné que les blocs de script s’exécutent dans différents threads, les variables d’objet passées par référence doivent être utilisées en toute sécurité. En règle générale, il est sûr de lire à partir d’objets référencés qui ne changent pas. Si vous devez modifier l’état de l’objet, vous devez utiliser des objets thread sécurisés, tels que les types .NET System.Collection.Concurrent (voir l’exemple 14).
Liens associés
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour