Informationen zu berechneten Eigenschaften
Kurze Beschreibung
PowerShell bietet die Möglichkeit, neue Eigenschaften dynamisch hinzuzufügen und die Formatierung der Objekte, die aus der Pipeline ausgegeben werden, zu ändern.
Lange Beschreibung
Eine Reihe von PowerShell-Cmdlets transformieren, Aggregat- oder Prozesseingabeobjekte in Ausgabeobjekte mithilfe von Parametern, die das Hinzufügen neuer Eigenschaften zu diesen Ausgabeobjekten ermöglichen. Diese Parameter können verwendet werden, um neue, berechnete Eigenschaften für Ausgabeobjekte basierend auf den Werten von Eingabeobjekten zu generieren. Die berechnete Eigenschaft wird durch eine Hashtable mit Schlüsselwertpaaren definiert, die den Namen der neuen Eigenschaft, einen Ausdruck zum Berechnen des Werts und optionale Formatierungsinformationen angeben.
Unterstützte Cmdlets
Die folgenden Cmdlets unterstützen berechnete Eigenschaftswerte für den Eigenschaftsparameter . Die Format-*
Cmdlets unterstützen auch berechnete Werte für den GroupBy-Parameter .
In der folgenden Liste werden die Cmdlets aufgeführt, die berechnete Eigenschaften und die Schlüsselwertpaare unterstützen, die von jedem Cmdlet unterstützt werden.
Compare-Object
expression
ConvertTo-Html
name
/label
- optional (hinzugefügt in PowerShell 6.x)expression
width
- optionalalignment
- optional
Format-Custom
expression
depth
- optional
Format-List
name
/label
- optionalexpression
formatstring
- optional
Diese Gruppe von Schlüsselwertpaaren gilt auch für berechnete Eigenschaftswerte, die an den GroupBy-Parameter für alle
Format-*
Cmdlets übergeben werden.Format-Table
name
/label
- optionalexpression
formatstring
- optionalwidth
- optionalalignment
- optional
Format-Wide
expression
formatstring
- optional
Group-Object
expression
Measure-Object
- Unterstützt nur einen Skriptblock für den Ausdruck, nicht eine Hashtable.
- In PowerShell 5.1 und älter nicht unterstützt.
Select-Object
name
/label
- optionalexpression
Sort-Object
expression
ascending
/descending
- optional
Hinweis
Der Wert des expression
Skriptblocks kann anstelle einer Hashtable ein Skriptblock sein. Weitere Informationen finden Sie im Abschnitt Hinweise.
Hashtable-Schlüsseldefinitionen
name
/label
- Gibt den Namen der zu erstellenden Eigenschaft an. Sie können den Alias oder dessen Alias verwendenname
,label
austauschbar.expression
- Ein Skriptblock, der zum Berechnen des Werts der neuen Eigenschaft verwendet wird.alignment
- Wird von Cmdlets verwendet, die tabellarische Ausgabe erzeugen, um zu definieren, wie die Werte in einer Spalte angezeigt werden. Der Wert muss'left'
,'center'
, oder'right'
sein.formatstring
- Gibt eine Formatzeichenfolge an, die definiert, wie der Wert für die Ausgabe formatiert wird. Weitere Informationen zu Formatzeichenfolgen finden Sie unter Formattypen in .NET.width
- Gibt die maximale Breite spalte in einer Tabelle an, wenn der Wert angezeigt wird. Der Wert muss größer sein als0
.depth
- Der Tiefenparameter vonFormat-Custom
gibt die Tiefe der Erweiterung für alle Eigenschaften an. Mit demdepth
Schlüssel können Sie die Tiefe der Erweiterung pro Eigenschaft angeben.ascending
/descending
- Ermöglicht Es Ihnen, die Reihenfolge der Sortierung für eine oder mehrere Eigenschaften anzugeben. Dies sind boolesche Werte.
Die Hashtableschlüssel müssen nicht geschrieben werden, solange das angegebene Namenspräfix eindeutig ist. Kann z. B n
Name
. anstelle von und e
anstelle von " verwendet werden" verwendet Expression
werden.
Beispiele
Compare-Object
Mit berechneten Eigenschaften können Sie steuern, wie die Eigenschaften der Eingabeobjekte verglichen werden. In diesem Beispiel werden die Werte nicht direkt verglichen, sondern mit dem Ergebnis des arithmetischen Vorgangs (Modulus von 2).
Compare-Object @{p=1} @{p=2} -property @{ Expression = { $_.p % 2 } }
$_.p % 2 SideIndicator
---------- -------------
0 =>
1 <=
ConvertTo-Html
ConvertTo-Html
kann eine Auflistung von Objekten in eine HTML-Tabelle konvertieren.
Berechnete Eigenschaften ermöglichen es Ihnen, zu steuern, wie die Tabelle angezeigt wird.
Get-Alias |
ConvertTo-Html Name,
Definition,
@{
name='ParameterCount'
expr={$_.Parameters.Keys.Count}
align='center'
} |
Out-File .\aliases.htm -Force
In diesem Beispiel wird eine HTML-Tabelle mit einer Liste von PowerShell-Aliasen und den Zahlenparametern für jeden aliasierten Befehl erstellt. Die Werte der ParameterCount-Spalte werden zentriert.
Format-Custom
Format-Custom
stellt eine benutzerdefinierte Ansicht eines Objekts in einem Format bereit, das einer Klassendefinition ähnelt. Komplexere Objekte können Elemente enthalten, die tief mit komplexen Typen geschachtelt sind. Der Tiefenparameter von Format-Custom
gibt die Tiefe der Erweiterung für alle Eigenschaften an. Mit dem depth
Schlüssel können Sie die Tiefe der Erweiterung pro Eigenschaft angeben.
In diesem Beispiel vereinfacht der depth
Schlüssel die benutzerdefinierte Ausgabe für das Get-Date
Cmdlet. Get-Date
gibt ein DateTime-Objekt zurück. Die Date-Eigenschaft dieses Objekts ist auch ein DateTime-Objekt , sodass das Objekt geschachtelt ist.
Get-Date | Format-Custom @{expr={$_.Date};depth=1},TimeOfDay
class DateTime
{
$_.Date =
class DateTime
{
Date = 8/7/2020 12:00:00 AM
Day = 7
DayOfWeek = Friday
DayOfYear = 220
Hour = 0
Kind = Local
Millisecond = 0
Minute = 0
Month = 8
Second = 0
Ticks = 637323552000000000
TimeOfDay = 00:00:00
Year = 2020
DateTime = Friday, August 07, 2020 12:00:00 AM
}
TimeOfDay =
class TimeSpan
{
Ticks = 435031592302
Days = 0
Hours = 12
Milliseconds = 159
Minutes = 5
Seconds = 3
TotalDays = 0.503508787386574
TotalHours = 12.0842108972778
TotalMilliseconds = 43503159.2302
TotalMinutes = 725.052653836667
TotalSeconds = 43503.1592302
}
}
Format-List
In diesem Beispiel verwenden wir berechnete Eigenschaften, um den Namen und das Format der Ausgabe aus zu Get-ChildItem
ändern.
Get-ChildItem *.json -File |
Format-List Fullname,
@{
name='Modified'
expression={$_.LastWriteTime}
formatstring='O'
},
@{
name='Size'
expression={$_.Length/1KB}
formatstring='N2'
}
FullName : C:\Git\PS-Docs\PowerShell-Docs\.markdownlint.json
Modified : 2020-07-23T10:26:28.4092457-07:00
Size : 2.40
FullName : C:\Git\PS-Docs\PowerShell-Docs\.openpublishing.publish.config.json
Modified : 2020-07-23T10:26:28.4092457-07:00
Size : 2.25
FullName : C:\Git\PS-Docs\PowerShell-Docs\.openpublishing.redirection.json
Modified : 2020-07-27T13:05:24.3887629-07:00
Size : 324.60
Format-Table
In diesem Beispiel fügt die berechnete Eigenschaft eine Type-Eigenschaft hinzu, die zum Klassifizieren der Dateien durch den Inhaltstyp verwendet wird.
Get-ChildItem -File |
Sort-Object extension |
Format-Table Name, Length -GroupBy @{
name='Type'
expression={
switch ($_.extension) {
'.md' {'Content'}
'' {'Metacontent'}
'.ps1' {'Automation'}
'.yml' {'Automation'}
default {'Configuration'}
}
}
}
Type: Metacontent
Name Length
---- ------
ThirdPartyNotices 1229
LICENSE-CODE 1106
LICENSE 19047
Type: Configuration
Name Length
---- ------
.editorconfig 183
.gitattributes 419
.gitignore 228
.markdownlint.json 2456
.openpublishing.publish.config.json 2306
.openpublishing.redirection.json 332394
.localization-config 232
Type: Content
Name Length
---- ------
README.md 3355
CONTRIBUTING.md 247
Type: Automation
Name Length
---- ------
.openpublishing.build.ps1 796
build.ps1 7495
ci.yml 645
ci-steps.yml 2035
daily.yml 1271
Format-Wide
Mit dem Format-Wide
Cmdlet können Sie den Wert einer Eigenschaft für Objekte in einer Auflistung als mehrspaltige Liste anzeigen.
In diesem Beispiel möchten wir den Dateinamen und die Größe (in Kilobyte) als breite Auflistung anzeigen. Da Format-Wide
mehr als eine Eigenschaft nicht angezeigt wird, verwenden wir eine berechnete Eigenschaft, um den Wert von zwei Eigenschaften in einen einzigen Wert zu kombinieren.
Get-ChildItem -File |
Format-Wide -Property @{e={'{0} ({1:N2}kb)' -f $_.name,($_.length/1kb)}}
.editorconfig (0.18kb) .gitattributes (0.41kb)
.gitignore (0.22kb) .localization-config (0.23kb)
.markdownlint.json (2.40kb) .openpublishing.build.ps1 (0.78kb)
.openpublishing.publish.config.json (2.25kb) .openpublishing.redirection.json (324.60kb)
build.ps1 (7.32kb) ci.yml (0.63kb)
ci-steps.yml (1.99kb) CONTRIBUTING.md (0.24kb)
daily.yml (1.24kb) LICENSE (18.60kb)
LICENSE-CODE (1.08kb) README.md (3.28kb)
ThirdPartyNotices (1.20kb)
Group-Object
Das Group-Object
Cmdlet zeigt Objekte in Gruppen basierend auf dem Wert einer angegebenen Eigenschaft an. In diesem Beispiel zählt die berechnete Eigenschaft die Anzahl der Dateien jedes Inhaltstyps.
Get-ChildItem -File |
Sort-Object extension |
Group-Object -NoElement -Property @{
expression={
switch ($_.extension) {
'.md' {'Content'}
'' {'Metacontent'}
'.ps1' {'Automation'}
'.yml' {'Automation'}
default {'Configuration'}
}
}
}
Count Name
----- ----
5 Automation
7 Configuration
2 Content
3 Metacontent
Measure-Object
Das Measure-Object
Cmdlet berechnet die numerischen Eigenschaften von Objekten. In diesem Beispiel verwenden wir eine berechnete Eigenschaft, um die Anzahl (Summe) der Zahlen zwischen 1 und 10 abzurufen, die gleichmäßig durch 3 teilbar sind.
1..10 | Measure-Object -Property {($_ % 3) -eq 0} -Sum
Count : 10
Average :
Sum : 3
Maximum :
Minimum :
StandardDeviation :
Property : ($_ % 3) -eq 0
Hinweis
Im Gegensatz zu den anderen Cmdlets Measure-Object
akzeptiert kein Hashtable für berechnete Eigenschaften. Sie müssen einen Skriptblock verwenden.
Select-Object
Sie können berechnete Eigenschaften verwenden, um zusätzliche Elemente zur Ausgabe der Objekte mit dem Select-Object
Cmdlet hinzuzufügen. In diesem Beispiel werden die PowerShell-Aliase aufgelistet, die mit dem Buchstaben C
beginnen. Mithilfe Select-Object
von , wir geben den Alias aus, das Cmdlet, dem es zugeordnet ist, und eine Anzahl der für das Cmdlet definierten Parameter. Mithilfe einer berechneten Eigenschaft können wir die ParameterCount-Eigenschaft erstellen.
$aliases = Get-Alias c* |
Select-Object Name,
Definition,
@{
name='ParameterCount'
expr={$_.Parameters.Keys.Count}
}
$aliases | Get-Member
$aliases
TypeName: Selected.System.Management.Automation.AliasInfo
Name MemberType Definition
---- ---------- ----------
Equals Method bool Equals(System.Object obj)
GetHashCode Method int GetHashCode()
GetType Method type GetType()
ToString Method string ToString()
Definition NoteProperty string Definition=Get-Content
Name NoteProperty string Name=cat
ParameterCount NoteProperty System.Int32 ParameterCount=21
Name Definition ParameterCount
---- ---------- --------------
cat Get-Content 21
cd Set-Location 15
cdd Push-MyLocation 1
chdir Set-Location 15
clc Clear-Content 20
clear Clear-Host 0
clhy Clear-History 17
cli Clear-Item 20
clp Clear-ItemProperty 22
cls Clear-Host 0
clv Clear-Variable 19
cnsn Connect-PSSession 29
compare Compare-Object 20
copy Copy-Item 24
cp Copy-Item 24
cpi Copy-Item 24
cpp Copy-ItemProperty 23
cvpa Convert-Path 13
Sort-Object
Mithilfe der berechneten Eigenschaften können Sie Daten in verschiedenen Bestellungen pro Eigenschaft sortieren. In diesem Beispiel werden Daten aus einer CSV-Datei in aufsteigender Reihenfolge nach Datum sortiert. Aber innerhalb jedes Datums sortiert es die Zeilen in absteigender Reihenfolge nach UnitsSold.
Import-Csv C:\temp\sales-data.csv |
Sort-Object Date, @{expr={$_.UnitsSold}; desc=$true}, Salesperson |
Select-Object Date, Salesperson, UnitsSold
Date Salesperson UnitsSold
---- ----------- ---------
2020-08-01 Sally 3
2020-08-01 Anne 2
2020-08-01 Fred 1
2020-08-02 Anne 6
2020-08-02 Fred 2
2020-08-02 Sally 0
2020-08-03 Anne 5
2020-08-03 Sally 3
2020-08-03 Fred 1
2020-08-04 Anne 2
2020-08-04 Fred 2
2020-08-04 Sally 2
Hinweise
Sie können den Ausdrucksskriptblock direkt als Argument angeben, anstatt ihn als
Expression
Eintrag in einer Hashtabelle anzugeben. Beispiel:'1', '10', '2' | Sort-Object { [int] $_ }
In diesem Beispiel ist es praktisch für Cmdlets, die keine Eigenschaft (oder Unterstützung) benötigen, die eine Eigenschaft über den
Name
Schlüssel, wie zSort-Object
. B. ,Group-Object
undMeasure-Object
.Für Cmdlets, die die Benennung der Eigenschaft unterstützen, wird der Skriptblock in eine Zeichenfolge konvertiert und als Name der Eigenschaft in der Ausgabe verwendet.
Expression
Skriptblöcke werden in untergeordneten Bereichen ausgeführt, was bedeutet, dass die Variablen des Aufrufers nicht direkt geändert werden können.Die Pipelinelogik wird auf die Ausgabe von
Expression
Skriptblöcken angewendet. Dies bedeutet, dass das Ausgabeen eines einzelnen Elementarrays dazu führt, dass das Array unwrappt wird.Für die meisten Cmdlets werden Fehler innerhalb von Ausdrucksskriptblöcken ruhig ignoriert. Für
Sort-Object
, Anweisungsterminierungs- und Skriptterminierungsfehler werden ausgegeben , aber sie beenden die Anweisung nicht.