ConvertTo-Json (Microsoft.PowerShell.Utility)

ConvertTo-Json

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

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

Синтаксис

ConvertTo-Json
              [-InputObject] <Object>
              [-Depth <Int32>]
              [-Compress]
              [-EnumsAsStrings]
              [-AsArray]
              [-EscapeHandling <StringEscapeHandling>]
              [<CommonParameters>]

Описание

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

Примечание

Начиная с PowerShell 7.2, свойства системы расширенных типов объектов DateTime и String больше не сериализуются, и только простой объект преобразуется в формат JSON.

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

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

Начиная с PowerShell 7.1, ConvertTo-Json выдает предупреждение, если глубина входного объекта превышает глубину, указанную для команды. Это предотвращает нежелательную потерю данных при преобразовании объектов.

Этот командлет был представлен в Windows PowerShell 3.0.

Примеры

Пример 1

(Get-UICulture).Calendar | ConvertTo-Json

{
  "MinSupportedDateTime": "0001-01-01T00:00:00",
  "MaxSupportedDateTime": "9999-12-31T23:59:59.9999999",
  "AlgorithmType": 1,
  "CalendarType": 1,
  "Eras": [
    1
  ],
  "TwoDigitYearMax": 2029,
  "IsReadOnly": true
}

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

Пример 2

Get-Date | ConvertTo-Json; Get-Date | ConvertTo-Json -AsArray

"2021-08-05T16:13:05.6394416-07:00"
[
  "2021-08-05T16:13:05.6421709-07:00"
]

В этом примере показаны выходные данные командлета ConvertTo-Json с параметром переключателя AsArray и без него. Вы можете видеть, что вторая часть вывода заключена в скобки массива.

Пример 3

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

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

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

Пример 4

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

{
  "DisplayHint": 2,
  "DateTime": "October 12, 2018 10:55:32 PM",
  "Date": "2018-10-12T00:00:00-05:00",
  "Day": 12,
  "DayOfWeek": 5,
  "DayOfYear": 285,
  "Hour": 22,
  "Kind": 2,
  "Millisecond": 639,
  "Minute": 55,
  "Month": 10,
  "Second": 32,
  "Ticks": 636749817326397744,
  "TimeOfDay": {
    "Ticks": 825326397744,
    "Days": 0,
    "Hours": 22,
    "Milliseconds": 639,
    "Minutes": 55,
    "Seconds": 32,
    "TotalDays": 0.95523888627777775,
    "TotalHours": 22.925733270666665,
    "TotalMilliseconds": 82532639.774400011,
    "TotalMinutes": 1375.54399624,
    "TotalSeconds": 82532.6397744
  },
  "Year": 2018
}

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

Пример 5

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.

Параметры

-AsArray

Выводит объект в скобках массива, даже если входные данные представляют собой один объект.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Compress

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

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Depth

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

Тип :: Int32
Позиция:: Именованный
Значение по умолчанию:: 2
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-EnumsAsStrings

Предоставляет альтернативный вариант сериализации, который преобразует все перечисления в их строковое представление.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-EscapeHandling

Управляет экранированием определенных символов в результирующем выводе JSON. По умолчанию экранируются только управляющие символы (например, новая строка).

Приемлемые значения:

По умолчанию — экранируются только управляющие символы.
EscapeNonAscii — все символы, отличные от ASCII, и управляющие символы экранируются.
EscapeHtml - HTML (<, >, &, ', ") и управляющие символы экранируются.

Этот параметр был введен в PowerShell 6.2.

Тип :: Newtonsoft.Json.StringEscapeHandling
Позиция:: Именованный
Значение по умолчанию:: По умолчанию
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-InputObject

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

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

Тип :: Объект
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

Входы

Объект

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

Выходы

Строка

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

Примечания

Командлет ConvertTo-Json реализован с использованием Newtonsoft Json.NET.