Condividi tramite

ConvertTo-Json

  • Riferimento
Modulo:
Microsoft.PowerShell.Utility

Converte un oggetto in una stringa in formato JSON.

Sintassi

ConvertTo-Json
              [-InputObject] <Object>
              [-Depth <Int32>]
              [-Compress]
              [<CommonParameters>]

Descrizione

Il ConvertTo-Json cmdlet converte qualsiasi oggetto .NET in una stringa in formato JSON (JavaScript Object Notation). Le proprietà vengono convertite in nomi di campo, i valori di campo vengono convertiti in valori di proprietà e i metodi vengono rimossi.

È quindi possibile usare il ConvertFrom-Json cmdlet per convertire una stringa in formato JSON in un oggetto JSON, che è facilmente gestito in PowerShell.

Molti siti Web usano JSON anziché XML per serializzare i dati per la comunicazione tra server e applicazioni basate sul Web.

Questo cmdlet è stato introdotto in Windows PowerShell 3.0.

Esempio

Esempio 1

(Get-UICulture).Calendar | ConvertTo-Json

{
    "MinSupportedDateTime":  "\/Date(-62135596800000)\/",
    "MaxSupportedDateTime":  "\/Date(253402300799999)\/",
    "AlgorithmType":  1,
    "CalendarType":  1,
    "Eras":  [
                 1
             ],
    "TwoDigitYearMax":  2029,
    "IsReadOnly":  false
}

Questo comando usa il ConvertTo-Json cmdlet per convertire un oggetto GregorianCalendar in una stringa in formato JSON.

Esempio 2

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

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

Questo comando mostra l'effetto dell'uso del parametro Compress di ConvertTo-Json. La compressione influisce solo sull'aspetto della stringa, non sulla validità.

Esempio 3

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

{
    "DisplayHint":  2,
    "DateTime":  "Friday, January 13, 2012 8:06:16 PM",
    "Date":  "\/Date(1326441600000)\/",
    "Day":  13,
    "DayOfWeek":  5,
    "DayOfYear":  13,
    "Hour":  20,
    "Kind":  2,
    "Millisecond":  221,
    "Minute":  6,
    "Month":  1,
    "Second":  16,
    "Ticks":  634620819762218083,
    "TimeOfDay":  {
                      "Ticks":  723762218083,
                      "Days":  0,
                      "Hours":  20,
                      "Milliseconds":  221,
                      "Minutes":  6,
                      "Seconds":  16,
                      "TotalDays":  0.83768775241087956,
                      "TotalHours":  20.104506057861109,
                      "TotalMilliseconds":  72376221.8083,
                      "TotalMinutes":  1206.2703634716668,
                      "TotalSeconds":  72376.22180829999
                  },
    "Year":  2012
}

Questo esempio usa il ConvertTo-Json cmdlet per convertire un oggetto System.DateTime dal Get-Date cmdlet a una stringa in formato JSON. Il comando usa il Select-Object cmdlet per ottenere tutte le* proprietà () dell'oggetto DateTime . L'output mostra la stringa ConvertTo-Json JSON restituita.

Esempio 4

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

Questo esempio illustra come usare i ConvertTo-Json cmdlet e ConvertFrom-Json per convertire un oggetto in una stringa JSON e in un oggetto JSON.

Parametri

-Compress

Omette gli spazi vuoti e la formattazione rientrata nella stringa di output.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Depth

Specifica il numero di livelli di oggetti contenuti inclusi nella rappresentazione JSON. Il valore può essere qualsiasi numero da 1 a 100. Il valore predefinito è 2. ConvertTo-Json genera un avviso se il numero di livelli in un oggetto di input supera questo numero.

Tipo:Int32
Posizione:Named
Valore predefinito:2
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-InputObject

Specifica gli oggetti da convertire in formato JSON. Immettere una variabile che contiene gli oggetti oppure digitare un comando o un'espressione che ottiene gli oggetti. È anche possibile inviare tramite pipe un oggetto a ConvertTo-Json.

Il parametro InputObject è obbligatorio, ma il relativo valore può essere null ($null) o una stringa vuota. Quando l'oggetto di input è $null, ConvertTo-Json non genera alcun output. Quando l'oggetto di input è una stringa vuota, ConvertTo-Json restituisce una stringa vuota.

Tipo:Object
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

Input

Object

È possibile inviare tramite pipe qualsiasi oggetto a questo cmdlet.

Output

String

Questo cmdlet restituisce una stringa che rappresenta l'oggetto di input convertito in una stringa JSON.

Note

Il ConvertTo-Json cmdlet viene implementato usando la classe JavaScriptSerializer.