ConvertTo-Json

Ссылка

Модуль:: Microsoft.PowerShell.Utility

Преобразует объект в строку в формате JSON.

Синтаксис

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

Описание

Командлет ConvertTo-Json преобразует любой объект .NET в строку в формате нотации объектов JavaScript (JSON). Свойства преобразуются в имена полей, значения полей преобразуются в значения свойств, а методы удаляются.

Затем можно использовать командлет ConvertFrom-Json для преобразования строки в формат JSON в объект JSON, который легко управляется в PowerShell.

Многие веб-сайты используют JSON вместо XML для сериализации данных для обмена данными между серверами и веб-приложениями.

Этот командлет появился в Windows PowerShell 3.0.

Примеры

Пример 1

(Get-UICulture).Calendar | ConvertTo-Json

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

Эта команда использует командлет ConvertTo-Json для преобразования объекта GregorianCalendar в строку в формате JSON.

Пример 2

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

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

Эта команда показывает эффект использования параметра сжатияConvertTo-Json. Сжатие влияет только на внешний вид строки, а не его допустимость.

Пример 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
}

В этом примере используется командлет ConvertTo-Json для преобразования объекта System.DateTime из командлета Get-Date в строку в формате JSON. Команда использует командлет Select-Object для получения всех (*) свойств объекта DateTime. В выходных данных показана строка JSON, возвращаемая ConvertTo-Json.

Пример 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

В этом примере показано, как использовать командлеты ConvertTo-Json и ConvertFrom-Json для преобразования объекта в строку JSON и объект JSON.

Параметры

-Compress

Опустить пробелы и отступное форматирование в выходной строке.

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Depth

Указывает, сколько уровней содержащихся объектов включены в представление JSON. Значение может быть любым числом от 1 до 100. Значение по умолчанию — 2. ConvertTo-Json выдает предупреждение, если число уровней в входном объекте превышает это число.

Тип:	Int32
Position:	Named
Default value:	2
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-InputObject

Указывает объекты для преобразования в формат JSON. Введите переменную, содержащую объекты, или введите команду или выражение, которое получает объекты. Можно также передать объект в ConvertTo-Json.

Требуется параметр InputObject, но его значение может иметь значение NULL ($null) или пустую строку. Если входной объект $null, ConvertTo-Json не создает выходные данные. Если входной объект является пустой строкой, ConvertTo-Json возвращает пустую строку.

Тип:	Object
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

Входные данные

Object

Вы можете передать любой объект в этот командлет.

Выходные данные

String

Этот командлет возвращает строку, представляющую входной объект, преобразованный в строку JSON.

Примечания

Командлет ConvertTo-Json реализуется с помощью класса JavaScriptSerializer.