ConvertFrom-Json

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

El cmdlet ConvertFrom-Json convierte una cadena en formato JSON (JavaScript Object Notation) en un PSObject personalizado o en un objeto Hashtable con una propiedad para cada campo en la cadena JSON. Los sitios web suelen usar JSON para proporcionar una representación textual de los objetos. El cmdlet agrega las propiedades al nuevo objeto a medida que procesa cada línea de la cadena JSON.

El estándar JSON permite nombres de clave duplicados, que están prohibidos en los tipos PSObject y Hashtable. Por ejemplo, si la cadena JSON contiene claves duplicadas, este cmdlet usa solo la última clave. Vea otros ejemplos a continuación.

Para generar una cadena JSON a partir de cualquier objeto, use el cmdlet ConvertTo-Json.

Este cmdlet se introdujo en PowerShell 3.0.

Este comando usa los cmdlets ConvertTo-Json y ConvertFrom-Json para convertir un objeto DateTime del cmdlet Get-Date a un objeto JSON y, a continuación, a un 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

En el ejemplo se usa el cmdlet Select-Object para obtener todas las propiedades del objeto DateTime. Usa el cmdlet ConvertTo-Json para convertir el objeto DateTime en una cadena con formato JSON y el cmdlet ConvertFrom-Json para convertir la cadena con formato JSON en un objeto PSCustomObject.

Este comando usa el cmdlet Invoke-WebRequest para obtener cadenas JSON de un servicio web y, a continuación, usa el cmdlet ConvertFrom-Json para convertir contenido JSON en objetos que se pueden administrar en 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

También puede usar el cmdlet Invoke-RestMethod, que convierte automáticamente el contenido JSON en objetos.

En este ejemplo se muestra cómo usar el cmdlet ConvertFrom-Json para convertir un archivo JSON en un objeto personalizado de PowerShell.

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

El comando usa Get-Content cmdlet para obtener las cadenas en un archivo JSON. El parámetro Raw devuelve todo el archivo como un único objeto JSON. A continuación, usa el operador de canalización para enviar la cadena delimitada al cmdlet ConvertFrom-Json, que lo convierte en un objeto personalizado.

Este comando muestra un ejemplo en el que el modificador -AsHashtable puede superar las limitaciones del comando.

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

La cadena JSON contiene dos pares clave-valor con claves que solo difieren en mayúsculas y minúsculas. Sin el conmutador, el comando habría producido un error.

Este comando muestra un ejemplo en el que el modificador -NoEnumerate se usa para realizar un recorrido de ida y vuelta de una matriz JSON de un solo elemento.

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

La cadena JSON contiene una matriz con un solo elemento. Sin el switch, la conversión del JSON a un PSObject y luego convertirlo de nuevo con el comando ConvertTo-Json resulta en un único número entero.

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Puede redirigir una cadena JSON a ConvertFrom-Json.

Este cmdlet se implementa mediante Newtonsoft Json.NET.

A partir de PowerShell 6, ConvertTo-Json intenta convertir cadenas con formato de marcas de tiempo a valores de DateTime. El valor convertido es una instancia de [datetime] con una propiedad Kind establecida de la siguiente manera:

• Unspecified, si no hay información de zona horaria en la cadena de entrada.
• Utc, si la información de zona horaria es una Z final.
• Local, si la información de la zona horaria se proporciona como una diferencia horaria con UTC final como +02:00. El desfase se convierte correctamente a la zona horaria configurada por el llamante. El formato de salida predeterminado no indica el desplazamiento de zona horaria original.

El tipo PSObject mantiene el orden de las propiedades tal como se muestra en la cadena JSON. A partir de PowerShell 7.3, el parámetro AsHashtable crea un OrderedHashtable. Los pares clave-valor se agregan en el orden presentado en la cadena JSON. El OrderedHashtable conserva ese orden.