ForEach-Object
Utför en åtgärd mot varje objekt i en samling indataobjekt.
Syntax
ScriptBlockSet (Standard)
ForEach-Object
[-Process] <ScriptBlock[]>
[-InputObject <PSObject>]
[-Begin <ScriptBlock>]
[-End <ScriptBlock>]
[-RemainingScripts <ScriptBlock[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PropertyAndMethodSet
ForEach-Object
[-MemberName] <String>
[-InputObject <PSObject>]
[-ArgumentList <Object[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cmdleten ForEach-Object utför en åtgärd på varje objekt i en samling indataobjekt. Indataobjekten kan skickas till cmdleten eller anges med hjälp av parametern InputObject .
Från och med Windows PowerShell 3.0 finns det två olika sätt att konstruera ett ForEach-Object kommando.
Syntax för skriptblock. Du kan använda ett skriptblock för att ange åtgärden. Använd variabeln i skriptblocket
$_för att representera det aktuella objektet. Skriptblocket är värdet för parametern Process . Skriptblocket kan innehålla valfritt PowerShell-skript.Följande kommando hämtar till exempel värdet för egenskapen ProcessName för varje process på datorn.
Get-Process | ForEach-Object {$_.ProcessName}ForEach-Objectstöder blockenbegin,processochendenligt beskrivningen i about_Functions.Anmärkning
Skriptblocken körs i anroparens omfång. Därför har blocken åtkomst till variabler i det omfånget och kan skapa nya variabler som finns kvar i omfånget när cmdleten har slutförts.
Förenklad syntax. Med den förenklade syntaxen anger du ett egenskaps- eller metodnamn för objektet i pipelinen.
ForEach-Objectreturnerar värdet för egenskapen eller metoden för varje objekt i pipelinen.Följande kommando hämtar till exempel även värdet för egenskapen ProcessName för varje process på datorn.
Get-Process | ForEach-Object ProcessNameDen förenklade syntaxen introducerades i Windows PowerShell 3.0. Mer information finns i about_Simplified_Syntax.
Exempel
Exempel 1: Dela upp heltal i en matris
Det här exemplet tar en matris med tre heltal och delar var och en av dem med 1024.
30000, 56798, 12432 | ForEach-Object -Process {$_/1024}
29.296875
55.466796875
12.140625
Exempel 2: Hämta längden på alla filer i en katalog
Det här exemplet bearbetar filerna och katalogerna i PowerShell-installationskatalogen $PSHOME.
Get-ChildItem $PSHOME | ForEach-Object -Process {
if (!$_.PSIsContainer) {$_.Name; $_.Length / 1024; " " }
}
Om objektet inte är en katalog hämtar skriptblocket namnet på filen, delar upp värdet för egenskapen Length med 1024 och lägger till ett blanksteg (" ") för att skilja det från nästa post. Cmdleten använder egenskapen PSIsContainer för att avgöra om ett objekt är en katalog.
Exempel 3: Arbeta med de senaste systemhändelserna
I det här exemplet skrivs de 1 000 senaste händelserna från systemhändelseloggen till en textfil. Den aktuella tiden visas före och efter bearbetning av händelserna.
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 hämtar de 1 000 senaste händelserna från systemhändelseloggen och skickar dem till cmdleten ForEach-Object . Parametern Begin visar aktuellt datum och tid. Därefter använder parametern Process cmdleten Out-File för att skapa en textfil med namnet events.txt och lagrar meddelandeegenskapen för var och en av händelserna i filen. Sist används parametern End för att visa datum och tid när all bearbetning har slutförts.
Exempel 4: Ändra värdet för en registernyckel
I det här exemplet ändras värdet för RemotePath-registerposten i alla undernycklar under HKCU:\Network nyckeln till versaler.
Get-ItemProperty -Path HKCU:\Network\* |
ForEach-Object {
Set-ItemProperty -Path $_.PSPath -Name RemotePath -Value $_.RemotePath.ToUpper()
}
Du kan använda det här formatet för att ändra formuläret eller innehållet i ett registerpostvärde.
Varje undernyckel i nätverksnyckeln representerar en mappad nätverksenhet som återansluter vid inloggning.
RemotePath-posten innehåller UNC-sökvägen för den anslutna enheten. Om du till exempel mappar E: enheten till \\Server\Shareskapas en E-undernyckel i HKCU:\Network med registervärdet RemotePath inställt på \\Server\Share.
Kommandot använder cmdleten Get-ItemProperty för att hämta alla undernycklar för nätverksnyckeln och cmdleten Set-ItemProperty för att ändra värdet för RemotePath-registerposten i varje nyckel.
Set-ItemProperty I kommandot är sökvägen värdet för PSPath-egenskapen för registernyckeln. Det här är en egenskap för Microsoft .NET Framework-objektet som representerar registernyckeln, inte en registerpost. Kommandot använder metoden ToUpper() för RemotePath-värdet , som är en sträng REG_SZ.
Eftersom Set-ItemProperty ändrar egenskapen för varje nyckel krävs cmdleten ForEach-Object för att få åtkomst till egenskapen.
Exempel 5: Använd den $null automatiska variabeln
Det här exemplet visar effekten av att skicka den $null automatiska variabeln till cmdleten ForEach-Object .
1, 2, $null, 4 | ForEach-Object {"Hello"}
Hello
Hello
Hello
Hello
Eftersom PowerShell behandlar $null som en explicit platshållare genererar cmdleten ForEach-Object ett värde för $null som det gör för andra objekt som skickas till den.
Exempel 6: Hämta egenskapsvärden
Det här exemplet hämtar värdet för egenskapen Path för alla installerade PowerShell-moduler med parametern MemberName i cmdleten ForEach-Object .
Get-Module -ListAvailable | ForEach-Object -MemberName Path
Get-Module -ListAvailable | foreach Path
Det andra kommandot motsvarar det första. Den använder aliaset Foreach för cmdleten ForEach-Object och utelämnar namnet på parametern MemberName , som är valfri.
Cmdleten ForEach-Object är användbar för att hämta egenskapsvärden, eftersom den hämtar värdet utan att ändra typen, till skillnad från cmdletarna Format eller cmdleten Select-Object , som ändrar egenskapsvärdetypen.
Exempel 7: Dela upp modulnamn i komponentnamn
Det här exemplet visar tre sätt att dela upp två punktavgränsade modulnamn i sina komponentnamn. Kommandona anropar metoden Dela upp i strängar. De tre kommandona använder olika syntax, men de är likvärdiga och utbytbara. Utdata är desamma för alla tre fallen.
"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
Det första kommandot använder den traditionella syntaxen, som innehåller ett skriptblock och den aktuella objektoperatorn $_. Den använder punktsyntaxen för att ange metoden och parenteserna för att omsluta avgränsningsargumentet.
Det andra kommandot använder parametern MemberName för att ange metoden Split och parametern ArgumentList för att identifiera punkten (.) som avgränsare för delad.
Det tredje kommandot använder aliaset foreach för cmdleten ForEach-Object och utelämnar namnen på parametrarna MemberName och ArgumentList , som är valfria.
Exempel 8: Använda ForEach-Object med två skriptblock
I det här exemplet skickar vi två skriptblock positionligt. Alla skriptblock binder till parametern Process . De behandlas dock som om de hade skickats till parametrarna Begin och Process .
1..2 | ForEach-Object { 'begin' } { 'process' }
begin
process
process
Exempel 9: Använda ForEach-Object med fler än två skriptblock
I det här exemplet skickar vi fyra skriptblock positionligt. Alla skriptblock binder till parametern Process . De behandlas dock som om de hade skickats till parametrarna Begin, Process och End .
1..2 | ForEach-Object { 'begin' } { 'process A' } { 'process B' } { 'end' }
begin
process A
process B
process A
process B
end
Anmärkning
Det första skriptblocket begin mappas alltid till blocket, det sista blocket mappas till end blocket och de två mellanblocken process mappas till blocket.
Exempel 10: Kör flera skriptblock för varje pipelineobjekt
Som du ser i föregående exempel mappas flera skriptblock som skickas med hjälp av processparametern till parametrarna Begin och End . För att undvika den här mappningen måste du ange explicita värden för parametrarna Begin och End .
1..2 | ForEach-Object -Begin $null -Process { 'one' }, { 'two' }, { 'three' } -End $null
one
two
three
one
two
three
Parametrar
-ArgumentList
Anger en matris med argument till ett metodanrop. Mer information om beteendet för ArgumentListfinns i about_Splatting.
Den här parametern introducerades i Windows PowerShell 3.0.
Parameteregenskaper
| Typ: | Object[] |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | Argument |
Parameteruppsättningar
PropertyAndMethodSet
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Begin
Anger ett skriptblock som körs innan den här cmdleten bearbetar indataobjekt. Det här skriptblocket körs bara en gång för hela pipelinen. Mer information om blocket finns i beginabout_Functions.
Parameteregenskaper
| Typ: | ScriptBlock |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
ScriptBlockSet
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Confirm
Uppmanar dig att bekräfta innan du kör cmdleten.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | jfr |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-End
Anger ett skriptblock som körs efter att den här cmdleten bearbetar alla indataobjekt. Det här skriptblocket körs bara en gång för hela pipelinen. Mer information om blocket finns i endabout_Functions.
Parameteregenskaper
| Typ: | ScriptBlock |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
ScriptBlockSet
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-InputObject
Anger indataobjekten.
ForEach-Object kör skriptblocket eller åtgärdssatsen för varje indataobjekt. Ange en variabel som innehåller objekten eller skriv ett kommando eller uttryck som hämtar objekten.
När du använder parametern InputObject med ForEach-Object, i stället för att skicka kommandoresultat till ForEach-Object, behandlas InputObject-värdet som ett enda objekt. Detta gäller även om värdet är en samling som är resultatet av ett kommando, till exempel -InputObject (Get-Process).
Eftersom InputObject inte kan returnera enskilda egenskaper från en matris eller en samling objekt rekommenderar vi att om du använder ForEach-Object för att utföra åtgärder på en samling objekt för de objekt som har specifika värden i definierade egenskaper använder ForEach-Object du i pipelinen, som du ser i exemplen i det här avsnittet.
Parameteregenskaper
| Typ: | PSObject |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | True |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-MemberName
Anger namnet på medlemsegenskapen som ska hämtas eller vilken medlemsmetod som ska anropas. Medlemmarna måste vara instansmedlemmar, inte statiska medlemmar.
Jokertecken tillåts, men fungerar bara om den resulterande strängen matchas till ett unikt värde.
Om du till exempel kör Get-Process | foreach -MemberName *Namematchar jokertecknet fler än en medlem, vilket gör att kommandot misslyckas.
Den här parametern introducerades i Windows PowerShell 3.0.
Parameteregenskaper
| Typ: | String |
| Standardvärde: | None |
| Stöder jokertecken: | True |
| DontShow: | False |
Parameteruppsättningar
PropertyAndMethodSet
| Position: | 0 |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Process
Anger den åtgärd som utförs på varje indataobjekt. Det här skriptblocket körs för varje objekt i pipelinen. Mer information om blocket finns i processabout_Functions.
När du anger flera skriptblock till parametern Process mappas alltid det första skriptblocket begin till blocket. Om det bara finns två skriptblock mappas det andra blocket till process blocket. Om det finns tre eller flera skriptblock mappas alltid det första skriptblocket begin till blocket, det sista blocket mappas till end blocket och de mellersta blocken process mappas till blocket.
Parameteregenskaper
| Typ: | |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
ScriptBlockSet
| Position: | 0 |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-RemainingScripts
Anger alla skriptblock som inte tas av parametern Process .
Den här parametern introducerades i Windows PowerShell 3.0.
Parameteregenskaper
| Typ: | |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
ScriptBlockSet
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-WhatIf
Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | Wi |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.
Indata
PSObject
Du kan skicka valfritt objekt till den här cmdleten.
Utdata
PSObject
Den här cmdleten returnerar objekt som bestäms av indata.
Kommentarer
Windows PowerShell innehåller följande alias för ForEach-Object:
%foreach
Cmdleten ForEach-Object fungerar ungefär som foreach-instruktionen, förutom att du inte kan skicka indata till en foreach-instruktion. Mer information om -instruktionen finns i foreachabout_Foreach.
Från och med PowerShell 4.0 Where har ForEach metoder lagts till för användning med samlingar. Du kan läsa mer om dessa nya metoder här about_Arrays