Udostępnij przez

ConvertTo-Json

Moduł:
Microsoft.PowerShell.Utility Module

Konwertuje obiekt na ciąg sformatowany w formacie JSON.

Składnia

Default (domyślnie) 

ConvertTo-Json
    [-InputObject] <Object>
    [-Depth <Int32>]
    [-Compress]
    [<CommonParameters>]

Opis

Polecenie cmdlet ConvertTo-Json konwertuje dowolny obiekt .NET na ciąg w formacie JavaScript Object Notation (JSON). Właściwości są konwertowane na nazwy pól, wartości pól są konwertowane na wartości właściwości, a metody są usuwane.

Następnie możesz użyć polecenia cmdlet ConvertFrom-Json, aby przekonwertować ciąg w formacie JSON na obiekt JSON, który jest łatwo zarządzany w programie PowerShell.

Wiele witryn sieci Web używa formatu JSON zamiast XML do serializacji danych na potrzeby komunikacji między serwerami i aplikacjami internetowymi.

To cmdlet zostało wprowadzone w Windows PowerShell 3.0.

Przykłady

Przykład 1

(Get-UICulture).Calendar | ConvertTo-Json

{
    "MinSupportedDateTime":  "\/Date(-62135596800000)\/",
    "MaxSupportedDateTime":  "\/Date(253402300799999)\/",
    "AlgorithmType":  1,
    "CalendarType":  1,
    "Eras":  [
                 1
             ],
    "TwoDigitYearMax":  2029,
    "IsReadOnly":  false
}

To polecenie używa polecenia cmdlet ConvertTo-Json, aby przekonwertować obiekt GregorianCalendar na ciąg w formacie JSON.

Przykład 2

@{Account="User01";Domain="Domain01";Admin="True"} | ConvertTo-Json -Compress

{"Domain":"Domain01","Account":"User01","Admin":"True"}

To polecenie pokazuje efekt użycia parametru CompressConvertTo-Json. Kompresja wpływa tylko na wygląd ciągu, a nie jego ważność.

Przykład 3

Get-Date | Select-Object -Property * | ConvertTo-Json

{
    "DisplayHint":  2,
    "DateTime":  "Friday, January 13, 2012 8:06:16 PM",
    "Date":  "\/Date(1326441600000)\/",
    "Day":  13,
    "DayOfWeek":  5,
    "DayOfYear":  13,
    "Hour":  20,
    "Kind":  2,
    "Millisecond":  221,
    "Minute":  6,
    "Month":  1,
    "Second":  16,
    "Ticks":  634620819762218083,
    "TimeOfDay":  {
                      "Ticks":  723762218083,
                      "Days":  0,
                      "Hours":  20,
                      "Milliseconds":  221,
                      "Minutes":  6,
                      "Seconds":  16,
                      "TotalDays":  0.83768775241087956,
                      "TotalHours":  20.104506057861109,
                      "TotalMilliseconds":  72376221.8083,
                      "TotalMinutes":  1206.2703634716668,
                      "TotalSeconds":  72376.22180829999
                  },
    "Year":  2012
}

W tym przykładzie użyto polecenia cmdlet ConvertTo-Json, aby przekonwertować obiekt System.DateTime z polecenia cmdlet Get-Date na ciąg w formacie JSON. Polecenie używa polecenia cmdlet Select-Object, aby pobrać wszystkie (*) właściwości obiektu DateTime. Dane wyjściowe zawierają ciąg JSON, który ConvertTo-Json zwrócony.

Przykład 4

Get-Date | Select-Object -Property * | ConvertTo-Json | ConvertFrom-Json

DisplayHint : 2
DateTime    : October 12, 2018 10:55:52 PM
Date        : 2018-10-12 12:00:00 AM
Day         : 12
DayOfWeek   : 5
DayOfYear   : 285
Hour        : 22
Kind        : 2
Millisecond : 768
Minute      : 55
Month       : 10
Second      : 52
Ticks       : 636749817527683372
TimeOfDay   : @{Ticks=825527683372; Days=0; Hours=22; Milliseconds=768; Minutes=55; Seconds=52;
              TotalDays=0.95547185575463; TotalHours=22.9313245381111; TotalMilliseconds=82552768.3372;
              TotalMinutes=1375.87947228667; TotalSeconds=82552.7683372}
Year        : 2018

W tym przykładzie pokazano, jak używać poleceń cmdlet ConvertTo-Json i ConvertFrom-Json, aby przekonwertować obiekt na ciąg JSON i obiekt JSON.

Parametry

-Compress

Pomija białe znaki i wcięcie formatowania w ciągu wyjściowym.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Depth

Określa, ile poziomów zawartych obiektów znajduje się w reprezentacji JSON. Wartość może być dowolną liczbą z 1 do 100. Wartość domyślna to 2. ConvertTo-Json emituje ostrzeżenie, jeśli liczba poziomów w obiekcie wejściowym przekracza tę liczbę.

Właściwości parametru

Typ:Int32
Domyślna wartość:2
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-InputObject

Określa obiekty do konwersji na format JSON. Wprowadź zmienną zawierającą obiekty lub wpisz polecenie lub wyrażenie, które pobiera obiekty. Możesz również przekazać obiekt do ConvertTo-Json.

Parametr InputObject jest wymagany, ale jego wartość może mieć wartość null ($null) lub pusty ciąg. Gdy obiekt wejściowy jest $null, ConvertTo-Json nie generuje żadnych danych wyjściowych. Gdy obiekt wejściowy jest pustym ciągiem, ConvertTo-Json zwraca pusty ciąg.

Właściwości parametru

Typ:Object
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:0
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

Object

Do tego polecenia cmdlet można przekierować dowolny obiekt.

Dane wyjściowe

String

To polecenie cmdlet zwraca ciąg reprezentujący obiekt wejściowy przekonwertowany na ciąg JSON.

Uwagi

Polecenie cmdlet ConvertTo-Json jest implementowane przy użyciu klasy JavaScriptSerializer.