ConvertTo-Json

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Convierte un objeto en una cadena con formato JSON.

Syntax

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

Description

El ConvertTo-Json cmdlet convierte cualquier objeto .NET en una cadena en formato de notación de objetos JavaScript (JSON). Las propiedades se convierten en nombres de campo, los valores de campo se convierten en valores de propiedad y se quitan los métodos.

Nota:

A partir de PowerShell 7.2, las propiedades del sistema de tipos extendidos de objetos DateTime y String ya no se serializan y solo el objeto simple se convierte en formato JSON.

A continuación, puede usar el ConvertFrom-Json cmdlet para convertir una cadena con formato JSON en un objeto JSON, que se administra fácilmente en PowerShell.

Muchos sitios web usan JSON en lugar de XML para serializar los datos para la comunicación entre servidores y aplicaciones web.

A partir de PowerShell 7.1, ConvertTo-Json emite una advertencia si la profundidad del objeto de entrada supera la profundidad especificada para el comando. Esto evita la pérdida de datos no deseados al convertir objetos.

Este cmdlet se introdujo en Windows PowerShell 3.0.

Ejemplos

Ejemplo 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
}

Este comando usa el ConvertTo-Json cmdlet para convertir un objeto GregorianoCalendar en una cadena con formato JSON.

Ejemplo 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"
]

En este ejemplo se muestra la salida del ConvertTo-Json cmdlet con y sin el parámetro switch AsArray . Puede ver que la segunda parte de la salida está ajustada entre corchetes de matriz.

Ejemplo 3

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

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

Este comando muestra el efecto de usar el parámetro Compress de ConvertTo-Json. La compresión afecta solo al aspecto de la cadena, no a su validez.

Ejemplo 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
}

En este ejemplo se usa el ConvertTo-Json cmdlet para convertir un objeto System.DateTime del Get-Date cmdlet en una cadena con formato JSON. El comando usa el Select-Object cmdlet para obtener todas las propiedades (*) del objeto DateTime . La salida muestra la cadena JSON que ConvertTo-Json devolvió.

Ejemplo 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

En este ejemplo se muestra cómo usar los ConvertTo-Json cmdlets y ConvertFrom-Json para convertir un objeto en una cadena JSON y un objeto JSON.

Parámetros

-AsArray

Genera el objeto entre corchetes de matriz, incluso si la entrada es un solo objeto.

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

-Compress

Omite los espacios en blanco y el formato con sangría en la cadena de resultado.

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

-Depth

Especifica cuántos niveles de objetos contenidos se incluyen en la representación JSON. El valor puede ser cualquier número de 0 a 100. El valor predeterminado es 2. ConvertTo-Json emite una advertencia si el número de niveles de un objeto de entrada supera este número.

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

-EnumsAsStrings

Proporciona una opción de serialización alternativa que convierte todas las enumeraciones en su representación de cadena.

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

-EscapeHandling

Controla cómo se escapan determinados caracteres en la salida JSON resultante. De forma predeterminada, solo se pueden escape los caracteres de control (como la nueva línea).

Los valores aceptables son:

  • Valor predeterminado: solo se escapan los caracteres de control.
  • EscapeNonAscii: todos los caracteres que no sean ASCII y de control se escapen.
  • EscapeHtml: los caracteres de escape HTML (<, >, &, ', ") y de control son caracteres de escape.

Este parámetro se introdujo en PowerShell 6.2.

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

-InputObject

Especifica los objetos que se van a convertir en formato JSON. Especifique una variable que contenga los objetos o escriba un comando o una expresión que obtenga los objetos. También puede canalizar un objeto a ConvertTo-Json.

Se requiere el parámetro InputObject , pero su valor puede ser NULL ($null) o una cadena vacía. Cuando el objeto de entrada es $null, ConvertTo-Json devuelve la representación JSON de null. Cuando el objeto de entrada es una cadena vacía, ConvertTo-Json devuelve la representación JSON de una cadena vacía.

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

Entradas

Object

Puede canalizar cualquier objeto a este cmdlet.

Salidas

String

Este cmdlet devuelve una cadena que representa el objeto de entrada convertido en una cadena JSON.

Notas

El ConvertTo-Json cmdlet se implementa mediante Newtonsoft Json.NET.