Delen via

ConvertTo-Json

  • Referentie
Module:
Microsoft.PowerShell.Utility

Converteert een object naar een tekenreeks met JSON-indeling.

Syntaxis

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

Description

Met de cmdlet ConvertTo-Json converteert u een .NET-object naar een tekenreeks in JSON-indeling (JavaScript Object Notation). De eigenschappen worden geconverteerd naar veldnamen, de veldwaarden worden geconverteerd naar eigenschapswaarden en de methoden worden verwijderd.

Vervolgens kunt u de cmdlet ConvertFrom-Json gebruiken om een tekenreeks met JSON-indeling te converteren naar een JSON-object, dat eenvoudig wordt beheerd in PowerShell.

Veel websites gebruiken JSON in plaats van XML om gegevens te serialiseren voor communicatie tussen servers en web-apps.

Deze cmdlet is geïntroduceerd in Windows PowerShell 3.0.

Voorbeelden

Voorbeeld 1

(Get-UICulture).Calendar | ConvertTo-Json

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

Met deze opdracht wordt de cmdlet ConvertTo-Json gebruikt om een GregorianCalendar-object te converteren naar een tekenreeks met JSON-indeling.

Voorbeeld 2

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

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

Met deze opdracht wordt het effect weergegeven van het gebruik van de parameter Comprimeren van ConvertTo-Json. De compressie is alleen van invloed op het uiterlijk van de tekenreeks, niet op de geldigheid ervan.

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

In dit voorbeeld wordt de cmdlet ConvertTo-Json gebruikt om een System.DateTime--object van de Get-Date-cmdlet te converteren naar een tekenreeks met JSON-indeling. De opdracht gebruikt de cmdlet Select-Object om alle eigenschappen (*) van het DateTime--object op te halen. De uitvoer toont de JSON-tekenreeks die ConvertTo-Json geretourneerd.

Voorbeeld 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

In dit voorbeeld ziet u hoe u de cmdlets ConvertTo-Json en ConvertFrom-Json gebruikt om een object te converteren naar een JSON-tekenreeks en een JSON-object.

Parameters

-Compress

Hiermee wordt witruimte en ingesprongen opmaak weggelaten in de uitvoertekenreeks.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Depth

Hiermee geeft u op hoeveel niveaus van ingesloten objecten worden opgenomen in de JSON-weergave. De waarde kan een willekeurig getal zijn van 1 tot 100. De standaardwaarde is 2. ConvertTo-Json een waarschuwing verzendt als het aantal niveaus in een invoerobject dit aantal overschrijdt.

Type:Int32
Position:Named
Default value:2
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-InputObject

Hiermee geeft u de objecten die moeten worden geconverteerd naar JSON-indeling. Voer een variabele in die de objecten bevat of typ een opdracht of expressie waarmee de objecten worden opgehaald. U kunt ook een object doorsluisen naar ConvertTo-Json.

De parameter InputObject is vereist, maar de waarde kan null ($null) of een lege tekenreeks zijn. Wanneer het invoerobject is $null, genereert ConvertTo-Json geen uitvoer. Wanneer het invoerobject een lege tekenreeks is, retourneert ConvertTo-Json een lege tekenreeks.

Type:Object
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

Invoerwaarden

Object

U kunt elk object doorsluisen naar deze cmdlet.

Uitvoerwaarden

String

Met deze cmdlet wordt een tekenreeks geretourneerd die het invoerobject vertegenwoordigt dat is geconverteerd naar een JSON-tekenreeks.

Notities

De ConvertTo-Json cmdlet wordt geïmplementeerd met behulp van de JavaScriptSerializer-klasse.