Sdílet prostřednictvím

ConvertTo-Json

  • Reference
Modul:
Microsoft.PowerShell.Utility

Převede objekt na řetězec ve formátu JSON.

Syntax

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

Description

Rutina ConvertTo-Json převede libovolný objekt .NET na řetězec ve formátu JSON (JavaScript Object Notation). Vlastnosti se převedou na názvy polí, hodnoty polí se převedou na hodnoty vlastností a metody se odeberou.

Pomocí této rutiny ConvertFrom-Json pak můžete převést řetězec ve formátu JSON na objekt JSON, který se snadno spravuje v PowerShellu.

Mnoho webů používá json místo XML k serializaci dat pro komunikaci mezi servery a webovými aplikacemi.

Tato rutina byla zavedena ve Windows PowerShellu 3.0.

Příklady

Příklad 1

(Get-UICulture).Calendar | ConvertTo-Json

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

Tento příkaz používá rutinu k převodu ConvertTo-Json GregorianCalendar objektu na řetězec ve formátu JSON.

Příklad 2

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

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

Tento příkaz ukazuje účinek použití parametru Compress parametru ConvertTo-Json. Komprese ovlivňuje pouze vzhled řetězce, nikoli jeho platnost.

Příklad 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
}

Tento příklad používá rutinu ConvertTo-Json k převodu objektu System.DateTime z rutiny Get-Date na řetězec ve formátu JSON. Příkaz používá rutinu Select-Object k získání všech (*) vlastností objektu DateTime . Ve výstupu se zobrazí vrácený řetězec ConvertTo-Json JSON.

Příklad 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

Tento příklad ukazuje, jak pomocí ConvertTo-Json rutin a ConvertFrom-Json převést objekt na řetězec JSON a objekt JSON.

Parametry

-Compress

Vynechá prázdné znaky a odsazení formátování ve výstupním řetězci.

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

-Depth

Určuje, kolik úrovní obsažených objektů je součástí reprezentace JSON. Hodnota může být libovolné číslo od 1 do 100. Výchozí hodnota je 2. ConvertTo-Json generuje upozornění, pokud počet úrovní ve vstupním objektu překročí toto číslo.

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

-InputObject

Určuje objekty, které se mají převést do formátu JSON. Zadejte proměnnou, která obsahuje objekty, nebo zadejte příkaz nebo výraz, který objekty získá. Objekt můžete také pipetovat na ConvertTo-Json.

Parametr InputObject je povinný, ale jeho hodnota může být null ($null) nebo prázdný řetězec. Pokud je $nullvstupní objekt , ConvertTo-Json negeneruje žádný výstup. Pokud je vstupním objektem prázdný řetězec, ConvertTo-Json vrátí prázdný řetězec.

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

Vstupy

Object

Do této rutiny můžete převést libovolný objekt.

Výstupy

String

Tato rutina vrátí řetězec představující vstupní objekt převedený na řetězec JSON.

Poznámky

Rutina ConvertTo-Json se implementuje pomocí třídy JavaScriptSerializer.