Поделиться через

ConvertTo-Json

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

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

Синтаксис

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

Описание

Командлет ConvertTo-Json преобразует любой объект .NET в строку в формате 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

{
  "value": "2018-10-12T23:07:18.8450248-05:00",
  "DisplayHint": 2,
  "DateTime": "October 12, 2018 11:07:18 PM"
}
[
  {
    "value": "2018-10-12T23:07:18.8480668-05:00",
    "DisplayHint": 2,
    "DateTime": "October 12, 2018 11:07:18 PM"
  }
]

В этом примере показаны выходные данные 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 . В выходных данных показана возвращенная строка ConvertTo-Json 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

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Compress

Исключает пробелы и отступы в выходной строке.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Depth

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

Type:Int32
Position:Named
Default value:2
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnumsAsStrings

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EscapeHandling

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

Допустимы следующие значения:

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

Этот параметр появился в PowerShell 6.2.

Type:Newtonsoft.Json.StringEscapeHandling
Position:Named
Default value:Default
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

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

Type:Object
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

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

Object

Можно передать по конвейеру любой объект в ConvertTo-Json.

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

String

Примечания

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