ConvertFrom-Json

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

Преобразует строку в формате JSON в пользовательский объект или хэш-таблицу.

Синтаксис

ConvertFrom-Json
                [-InputObject] <String>
                [-AsHashtable]
                [-Depth <Int32>]
                [-NoEnumerate]
                [<CommonParameters>]

Описание

Командлет ConvertFrom-Json преобразует отформатированную строку JavaScript в настраиваемый объект PSObject или Hashtable , имеющий свойство для каждого поля в строке JSON. Формат JSON обычно используется на веб-сайтах для текстового представления объектов. Командлет добавляет свойства в новый объект, обрабатывая каждую строку строки JSON.

Стандарт JSON позволяет дублировать имена ключей, которые запрещены в типах PSObject и Hashtable . Например, если строка JSON содержит повторяющиеся ключи, этот командлет использует только последний ключ. См. другие примеры ниже.

Чтобы создать строку JSON из любого объекта, используйте ConvertTo-Json командлет.

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

Примечание.

Начиная с PowerShell 6 командлет поддерживает JSON с комментариями. Примечания JSON начинаются с двух символов косой черты (//). Комментарии JSON не записываются в выходных данных объектов командлетом. До PowerShell 6 ConvertFrom-Json возвращает ошибку при обнаружении комментария JSON.

Примеры

Пример 1. Преобразование объекта DateTime в объект JSON

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

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

DisplayHint : 2
DateTime    : Friday, January 13, 2012 8:06:31 PM
Date        : 1/13/2012 8:00:00 AM
Day         : 13
DayOfWeek   : 5
DayOfYear   : 13
Hour        : 20
Kind        : 2
Millisecond : 400
Minute      : 6
Month       : 1
Second      : 31
Ticks       : 634620819914009002
TimeOfDay   : @{Ticks=723914009002; Days=0; Hours=20; Milliseconds=400; Minutes=6; Seconds=31; TotalDays=0.83786343634490734; TotalHours=20.108722472277776; TotalMilliseconds=72391400.900200009; TotalMinutes=1206.5233483366667;TotalSeconds=72391.4009002}
Year        : 2012

В примере используется Select-Object командлет для получения всех свойств объекта DateTime . Он использует ConvertTo-Json командлет для преобразования объекта DateTime в строку, отформатированную как объект JSON, и ConvertFrom-Json командлет для преобразования строки в формат JSON в объект PSCustomObject .

Пример 2. Получение строк JSON из веб-службы и их преобразование в объекты PowerShell

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

# Ensures that Invoke-WebRequest uses TLS 1.2
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
$j = Invoke-WebRequest 'https://api.github.com/repos/PowerShell/PowerShell/issues' | ConvertFrom-Json

Можно также использовать командлет, который автоматически преобразует содержимое Invoke-RestMethod JSON в объекты.

Пример 3. Преобразование строки JSON в пользовательский объект

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

Get-Content -Raw JsonFile.JSON | ConvertFrom-Json

Команда использует командлет Get-Content для получения строк в JSON-файле. Необработанный параметр возвращает весь файл в виде одного объекта JSON. Затем он использует оператор конвейера для отправки строки ConvertFrom-Json с разделителями в командлет, который преобразует его в пользовательский объект.

Пример 4. Преобразование строки JSON в хэш-таблицу

Эта команда показывает пример, в котором -AsHashtable переключатель может преодолеть ограничения команды.

'{ "key":"value1", "Key":"value2" }' | ConvertFrom-Json -AsHashtable

Строка JSON содержит две пары "значение ключа" с ключами, которые отличаются только в регистре. Без переключателя команда приведет к ошибке.

Пример 5. Циклический обход массива элементов

Эта команда показывает пример -NoEnumerate использования коммутатора для обхода массива JSON одного элемента.

Write-Output "With -NoEnumerate: $('[1]' | ConvertFrom-Json -NoEnumerate | ConvertTo-Json -Compress)"
Write-Output "Without -NoEnumerate: $('[1]' | ConvertFrom-Json | ConvertTo-Json -Compress)"

With -NoEnumerate: [1]
Without -NoEnumerate: 1

Строка JSON содержит массив с одним элементом. Без переключателя преобразование JSON в PSObject и последующее преобразование его обратно с ConvertTo-Json помощью команды приводит к одному целому значению.

Параметры

-AsHashtable

Преобразует JSON в объект хэш-таблицы. Этот параметр был представлен в PowerShell 6.0. Начиная с PowerShell 7.3, объект является УпорядоченнымHashtable и сохраняет порядок ключей из JSON. В предыдущих версиях объект является хэш-файлом.

Существует несколько сценариев, в которых она может преодолеть некоторые ограничения командлета ConvertFrom-Json .

  • Без этого параметра, если два или более ключей в объекте JSON не учитывает регистр, они обрабатываются как идентичные ключи. В этом случае в преобразованный объект включен только последний из этих ключей без учета регистра.
  • Без этого параметра командлет выдает ошибку всякий раз, когда JSON содержит ключ, который является пустой строкой. PSCustomObject не может иметь имена свойств, которые являются пустыми строками. Например, это может произойти в project.lock.json файлах.
  • Хэш-таблицы можно обрабатывать быстрее для определенных структур данных.
Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Depth

Возвращает или задает максимальную глубину входных данных JSON. Значение по умолчанию — 1024.

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

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

-InputObject

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

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

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

-NoEnumerate

Указывает, что выходные данные не перечисляются.

Установка этого параметра приводит к отправке массивов в виде одного объекта вместо отправки каждого элемента отдельно. Это гарантирует, что JSON может быть циклический споткнут через ConvertTo-Json.

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

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

String

Можно передать строку JSON в ConvertFrom-Json.

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

PSCustomObject

OrderedHashtable

Примечания

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

Начиная с PowerShell 6, ConvertTo-Json пытается преобразовать строки, отформатированные как метки времени в значения DateTime . Преобразованное значение — это [datetime] экземпляр со свойством Kind , заданным следующим образом:

  • Unspecified, если в входной строке нет сведений часового пояса.
  • Utc, если сведения часового пояса являются конечными Z.
  • Local, если данные часового пояса заданы в качестве смещения в формате UTC, например+02:00. Смещение правильно преобразуется в настроенный часовой пояс вызывающего абонента. Форматирование выходных данных по умолчанию не указывает исходное смещение часового пояса.

Тип PSObject поддерживает порядок свойств, представленных в строке JSON. Начиная с PowerShell 7.3, параметр AsHashtable создает упорядоченнуюhtable. Пары "ключ-значение" добавляются в порядке, представленном в строке JSON. OrderHashtable сохраняет этот порядок.