Drukowanie właściwości obiektu w programie PowerShell

Podczas pracy w konsoli interaktywnej, jeśli zdefiniuję nowy obiekt i przypiszę mu kilka wartości właściwości w następujący sposób:

$obj = New-Object System.String
$obj | Add-Member NoteProperty SomeProperty "Test"

Następnie, kiedy wpiszę nazwę mojej zmiennej w interaktywnym oknie, program PowerShell wyświetli podsumowanie właściwości i wartości obiektu:

PS C:\demo> $obj
SomeProperty                                                                                                                                                                                  
------------                                                                                                                                                                                  
Test

Zasadniczo chcę to zrobić, ale z poziomu funkcji w skrypcie. Funkcja tworzy obiekt i ustawia niektóre wartości właściwości i chcę, aby przed zwróceniem wydrukowała podsumowanie wartości obiektu w oknie programu PowerShell. Próbowałem użyć Write-Host w funkcji:

Write-Host $obj

Ale to tylko wyświetla typ obiektu, a nie podsumowanie:

System.Object

W jaki sposób mogę sprawić, aby funkcja wyprowadzała podsumowanie wartości właściwości obiektu w oknie programu PowerShell?

Spróbuj tego:

Write-Host ($obj | Format-Table | Out-String)

lub

Write-Host ($obj | Format-List | Out-String)

Moim rozwiązaniem tego problemu było użycie bloku wyrażenia podrzędnego $ () .

Add-Type -Language CSharp @"
public class Thing{
    public string Name;
}
"@;

$x = New-Object Thing

$x.Name = "Bill"

Write-Output "My name is $($x.Name)"
Write-Output "This won't work right: $x.Name"

Daje:

My name is Bill
This won't work right: Thing.Name

Aby wydrukować właściwości i wartości obiektu w programie PowerShell. Poniższe przykłady sprawdzają się u mnie dobrze.

$ pool = Get-Item "IIS: \ AppPools.NET v4.5"

$ pool | Get-Member

   TypeName: Microsoft.IIs.PowerShell.Framework.ConfigurationElement#system.applicationHost/applicationPools#add

Name                        MemberType            Definition
----                        ----------            ----------
Recycle                     CodeMethod            void Recycle()
Start                       CodeMethod            void Start()
Stop                        CodeMethod            void Stop()
applicationPoolSid          CodeProperty          Microsoft.IIs.PowerShell.Framework.CodeProperty
state                       CodeProperty          Microsoft.IIs.PowerShell.Framework.CodeProperty
ClearLocalData              Method                void ClearLocalData()
Copy                        Method                void Copy(Microsoft.IIs.PowerShell.Framework.ConfigurationElement ...
Delete                      Method                void Delete()
...

$ pool | Select-Object -Property * # Możesz pominąć -Property

name                        : .NET v4.5
queueLength                 : 1000
autoStart                   : True
enable32BitAppOnWin64       : False
managedRuntimeVersion       : v4.0
managedRuntimeLoader        : webengine4.dll
enableConfigurationOverride : True
managedPipelineMode         : Integrated
CLRConfigFile               :
passAnonymousToken          : True
startMode                   : OnDemand
state                       : Started
applicationPoolSid          : S-1-5-82-271721585-897601226-2024613209-625570482-296978595
processModel                : Microsoft.IIs.PowerShell.Framework.ConfigurationElement
...

Wskazówka nr 1

Nigdy nie używaj Write-Host.

Porada nr 12

Prawidłowym sposobem wyprowadzania informacji z polecenia cmdlet lub funkcji programu PowerShell jest utworzenie obiektu zawierającego dane, a następnie zapisanie tego obiektu w potoku przy użyciu funkcji Write-Output.

-Don Jones: Mistrz PowerShell

Idealnie byłoby, gdyby twój skrypt utworzył twoje obiekty ( $obj = New-Object -TypeName psobject -Property @{'SomeProperty'='Test'}), a następnie po prostu wykonałby plik Write-Output $objects. Możesz potokować wyjście do Format-Table.

PS C:\> Run-MyScript.ps1 | Format-Table

Powinni naprawdę wywołać PowerShell PowerObjectandPipingShell.

Kilka uwag ogólnych.

$obj | Select-Object ⊆ $obj | Select-Object -Property *

Ta ostatnia pokaże wszystkie nie wewnętrzne, nie wygenerowane przez kompilator właściwości. Pierwsza z nich nie wydaje się (zawsze) pokazywać wszystkich typów właściwości (w moich testach wydaje się, że pokazuje to CodeProperty MemberTypekonsekwentnie - tutaj nie ma gwarancji).

Niektóre przełączniki, o których należy pamiętać w przypadku Get-Member

• Get-Memberma nie dostać elementy statyczne domyślnie. Nie możesz również (bezpośrednio) uzyskać ich razem z niestatycznymi członkami. Oznacza to, że użycie przełącznika powoduje zwrócenie tylko statycznych elementów członkowskich:
  

  PS Y:\Power> $obj | Get-Member -Static
  
     TypeName: System.IsFire.TurnUpProtocol
  
  Name        MemberType Definition
  ----        ---------- ----------
  Equals      Method     static bool Equals(System.Object objA, System.Object objB)
  ...

• Użyj -Force.

  Get-MemberKomenda używa Mocy parametr dodać swoistych członków i kompilatora generowane z obiektów na ekranie. Get-Memberpobiera tych członków, ale domyślnie ich ukrywa.

  PS Y:\Power> $obj | Get-Member -Static
  
     TypeName: System.IsFire.TurnUpProtocol
  
  Name          MemberType     Definition
  ----          ----------     ----------
  ...
  pstypenames   CodeProperty   System.Collections.ObjectModel.Collection...
  psadapted     MemberSet      psadapted {AccessRightType, AccessRuleType,...
  ...

Używaj ConvertTo-Jsondo dokładnej i czytelnej „serializacji”

Ja nie niezbędne polecić zapisywanie obiektów za pomocą JSON (stosowanie Export-Clixmlzamiast). Można jednak uzyskać mniej lub bardziej czytelne dane wyjściowe ConvertTo-Json, co pozwala również określić głębokość.

Zauważ, że brak określenia Depthoznacza-Depth 2

PS Y:\Power> ConvertTo-Json $obj -Depth 1
{
    "AllowSystemOverload":  true,
    "AllowLifeToGetInTheWay":  false,
    "CantAnyMore": true,
    "LastResortOnly": true,
...

A jeśli nie planujesz tego czytać, możesz to -Compresszrobić (tj. Usuń spacje)

PS Y:\Power> ConvertTo-Json $obj -Depth 420 -Compress

Użyj, -InputObjectjeśli możesz (i chcesz)

99,9% czasu podczas korzystania z PowerShell: albo wydajność nie ma znaczenia, albo nie przejmujesz się wydajnością. Jednakże , należy zauważyć, że unikanie rurę, kiedy nie potrzeba może zaoszczędzić trochę napowietrznych i dodać trochę prędkości (rurociągi, ogólnie rzecz biorąc, nie jest super-wydajny).

Oznacza to, że jeśli masz wszystko, co masz, to jedna $objporęczna do drukowania (i nie jesteś tak leniwy jak ja, żeby czasami pisać -InputObject):

# select is aliased (hardcoded) to Select-Object
PS Y:\Power> select -Property * -InputObject $obj

# gm is aliased (hardcoded) to Get-Member
PS Y:\Power> gm -Force -InputObject $obj

Uwaga na Get-Member -InputObject: jeśli $ obj jest kolekcją (np. System.Object[]), W końcu uzyskujesz informacje o samym obiekcie kolekcji:

PS Y:\Power> gm -InputObject $obj,$obj2
   TypeName: System.Object[]

Name        MemberType            Definition
----        ----------            ----------
Count       AliasProperty         Count = Length
...

Jeśli chcesz Get-Memberdla każdego TypeNamew kolekcji (uwaga dla każdego TypeName, nie dla każdego obiektu - zbiór N obiektów z takimi samymi TypeNamewypisuje tylko 1 tabelę TypeName, a nie N tabel dla każdego obiektu) ...... po prostu trzymaj się go bezpośrednio.

Poniższe działały naprawdę dobrze dla mnie. Poprawiłem wszystkie powyższe odpowiedzi oraz przeczytałem o wyświetlaniu właściwości obiektów w poniższym linku i wymyśliłem poniżej krótką lekturę o drukowaniu obiektów

dodaj następujący tekst do pliku o nazwie print_object.ps1:

$date = New-Object System.DateTime
Write-Output $date | Get-Member
Write-Output $date | Select-Object -Property *

otwórz wiersz polecenia powershell, przejdź do katalogu, w którym istnieje ten plik i wpisz:

powershell -ExecutionPolicy ByPass -File is_port_in_use.ps1 -Elevated

Po prostu zastąp „System.DateTime” dowolnym obiektem, który chcesz wydrukować. Jeśli obiekt jest pusty, nic nie zostanie wydrukowane.

# Json to object
$obj = $obj | ConvertFrom-Json
Write-host $obj.PropertyName