about_Calculated_Properties

Rövid leírás

A PowerShell lehetővé teszi új tulajdonságok dinamikus hozzáadását és az objektumok kimenetének formázását a folyamaton.

Hosszú leírás

Számos PowerShell-parancsmag konvertálja, csoportosítja vagy dolgozza fel a bemeneti objektumokat kimeneti objektumokká olyan paraméterek használatával, amelyek lehetővé teszik új tulajdonságok hozzáadását ezekhez a kimeneti objektumokhoz. Ezekkel a paraméterekkel új, számított tulajdonságokat hozhat létre a kimeneti objektumokon a bemeneti objektumok értékei alapján. A számított tulajdonságot egy kulcs-érték párokat tartalmazó kivonatoló határozza meg, amely megadja az új tulajdonság nevét, az érték kiszámításához használt kifejezést és az opcionális formázási információkat.

Támogatott parancsmagok

Az alábbi parancsmagok a Tulajdonság paraméter számított tulajdonságértékeit támogatják. A Format-* parancsmagok a GroupBy paraméter számított értékeit is támogatják.

Az alábbi lista a számított tulajdonságokat támogató parancsmagokat és az egyes parancsmagok által támogatott kulcs-érték párokat sorolja fel.

  • Compare-Object

    • expression
  • ConvertTo-Html

    • name/label - nem kötelező (a PowerShell 6.x-ben hozzáadva)
    • expression
    • width -Választható
    • alignment -Választható
  • Format-Custom

    • expression
    • depth -Választható
  • Format-List

    • name/label -Választható
    • expression
    • formatstring -Választható

    Ugyanez a kulcs-érték párok a GroupBy paraméternek átadott számított tulajdonságértékekre is vonatkoznak az összes Format-* parancsmag esetében.

  • Format-Table

    • name/label -Választható
    • expression
    • formatstring -Választható
    • width -Választható
    • alignment -Választható
  • Format-Wide

    • expression
    • formatstring -Választható
  • Group-Object

    • expression
  • Measure-Object

    • Csak a kifejezés szkriptblokkját támogatja, nem kivonatolót.
    • A PowerShell 5.1-ben és régebbi verzióiban nem támogatott.
  • Select-Object

    • name/label -Választható
    • expression
  • Sort-Object

    • expression
    • ascending/descending -Választható

Feljegyzés

A függvény értéke expression lehet egy szkriptblokk a kivonatoló helyett. További információkért lásd a Jegyzetek szakaszt.

Kivonatolókulcs-definíciók

  • name/label – Megadja a létrehozandó tulajdonság nevét. name Használhatja vagy aliasát, labelfelcserélhetően.
  • expression - Az új tulajdonság értékének kiszámításához használt sztring vagy szkriptblokk. Ha ez expression egy sztring, az érték a bemeneti objektum tulajdonságneveként lesz értelmezve. Ez rövidebb lehetőség, mint expression = { $_.<PropertyName> }a .
  • alignment – Táblázatos kimenetet eredményező parancsmagok használják az értékek oszlopban való megjelenítésének meghatározására. Az értéknek 'left', 'center'vagy 'right'.
  • formatstring – Egy formátumsztringet ad meg, amely meghatározza, hogy az érték hogyan legyen formázva a kimenethez. További információ a formázási sztringekről: Formátumtípusok a .NET-ben.
  • width – A tábla maximális szélességű oszlopát adja meg az érték megjelenítésekor. Az értéknek nagyobbnak kell lennie, mint 0.
  • depth - A Mélység paraméter Format-Custom az összes tulajdonsághoz megadja a bővítés mélységét. A depth kulcs lehetővé teszi a tulajdonságonkénti bővítés mélységének megadását.
  • ascending / descending – Lehetővé teszi egy vagy több tulajdonság rendezési sorrendjének megadását. Ezek logikai értékek.

Nem kell megadnia a kivonatolókulcsokat, amíg a megadott névelőtag egyértelmű. Használhatja például n a helyett Name és e helyett is Expression.

Példák

Compare-Object

Számított tulajdonságokkal szabályozhatja a bemeneti objektumok tulajdonságainak összehasonlítását. Ebben a példában az értékek közvetlen összehasonlítása helyett az értékek az aritmetikai művelet eredményével (2 modulus) lesznek összehasonlítva.

Compare-Object @{p=1} @{p=2} -property @{ Expression = { $_.p % 2 } }
 $_.p % 2  SideIndicator
---------- -------------
         0 =>
         1 <=

ConvertTo-Html

ConvertTo-Html objektumgyűjteményt HTML-táblázattá alakíthat át. A számított tulajdonságok lehetővé teszik a tábla megjelenítési módjának szabályozását.

Get-Alias |
  ConvertTo-Html Name,
                 Definition,
                 @{
                    name='ParameterCount'
                    expr={$_.Parameters.Keys.Count}
                    align='center'
                 } |
    Out-File .\aliases.htm -Force

Ez a példa létrehoz egy HTML-táblázatot, amely tartalmazza a PowerShell-aliasok listáját és az egyes aliasolt parancsok számparamétereit. A ParameterCount oszlop értékei középre vannak adva.

Format-Custom

Format-Custom Az objektum egyéni nézetét az osztálydefinícióhoz hasonló formátumban biztosítja. Az összetettebb objektumok olyan tagokat tartalmazhatnak, amelyek mélyen beágyazottak összetett típusokkal. A Mélység paraméter Format-Custom az összes tulajdonsághoz megadja a bővítés mélységét. A depth kulcs lehetővé teszi a tulajdonságonkénti bővítés mélységének megadását.

Ebben a példában a depth kulcs leegyszerűsíti a parancsmag egyéni kimenetét Get-Date . Get-DateEgy DateTime objektumot ad vissza. Az objektum Date tulajdonsága szintén DateTime objektum, így az objektum beágyazva van.

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

Ebben a példában számított tulajdonságokat használunk a kimenet nevének és formátumának módosításához Get-ChildItem.

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

Ebben a példában a számított tulajdonság hozzáad egy Típus tulajdonságot, amellyel a fájlokat tartalomtípus szerint osztályozhatja.

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

A Format-Wide parancsmag lehetővé teszi egy gyűjtemény objektumainak egy tulajdonságának többoszlopos listaként való megjelenítését.

Ebben a példában széles listaelemként szeretnénk látni a fájlnevet és a méretet (kilobájtban). Mivel Format-Wide nem jelenít meg egynél több tulajdonságot, egy számított tulajdonsággal egyesítjük a két tulajdonság értékét egyetlen értékben.

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

A Group-Object parancsmag egy adott tulajdonság értéke alapján csoportokban jeleníti meg az objektumokat. Ebben a példában a számított tulajdonság megszámolja az egyes tartalomtípusok fájljainak számát.

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

A Measure-Object parancsmag kiszámítja az objektumok numerikus tulajdonságait. Ebben a példában egy számított tulajdonságot használunk az 1 és 10 közötti számok számának (Összeg) lekéréséhez, amelyek egyenlően oszthatóak 3-tal.

1..10 | Measure-Object -Property {($_ % 3) -eq 0} -Sum
Count             : 10
Average           :
Sum               : 3
Maximum           :
Minimum           :
StandardDeviation :
Property          : ($_ % 3) -eq 0

Feljegyzés

A többi parancsmagtól Measure-Object eltérően nem fogad el kivonatolót a számított tulajdonságokhoz. Szkriptblokkot kell használnia.

Select-Object

Számított tulajdonságok használatával további tagokat adhat hozzá az objektumok kimenetéhez a Select-Object parancsmaggal. Ebben a példában a betűvel Ckezdődő PowerShell-aliasokat soroljuk fel. A használatával Select-Objectkibocsátjuk az aliast, a hozzárendelt parancsmagot, valamint a parancsmaghoz definiált paraméterek számát. Számított tulajdonság használatával létrehozhatjuk a ParameterCount tulajdonságot.

$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

A számított tulajdonságok használatával az adatokat tulajdonságonként különböző sorrendben rendezheti. Ez a példa növekvő sorrendben rendezi az adatokat egy CSV-fájlból dátum szerint. Az egyes dátumokon belül azonban csökkenő sorrendben rendezi a sorokat a UnitsSold szerint.

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

Jegyzetek

  • A kifejezésszkriptblokkot közvetlenül, argumentumként is megadhatja ahelyett, hogy egy kivonatoló bejegyzéseként Expression adja meg. Példa:

    '1', '10', '2' | Sort-Object { [int] $_ }
    

    Ez a példa olyan parancsmagok esetében használható, amelyek nem igényelnek (vagy támogatnak) tulajdonság elnevezését a Name kulcson keresztül, például Sort-Object: , Group-Objectés Measure-Object.

    A tulajdonság elnevezését támogató parancsmagok esetében a szkriptblokk sztringgé alakul, és a kimenet tulajdonságának neveként használatos.

  • Expressiona szkriptblokkok gyermek hatókörökben futnak, ami azt jelenti, hogy a hívó változói nem módosíthatók közvetlenül.

  • A folyamatlogika a szkriptblokkok kimenetére Expression lesz alkalmazva. Ez azt jelenti, hogy az egyelemes tömb kimenete miatt a tömb nincs leképezve.

  • A legtöbb parancsmag esetében a kifejezésszkriptblokkok hibáit a rendszer csendben figyelmen kívül hagyja. Az Sort-Objectutasítás-megszakítási és szkript-megszakítási hibák kimenetek, de nem zárják le az utasítást.

Lásd még