Sdílet prostřednictvím

ConvertTo-Json

Modul:
Microsoft.PowerShell.Utility Module

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

Syntax

Default (Výchozí) 

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

Description

Rutina ConvertTo-Json převede libovolný objekt 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.

Potom můžete pomocí rutiny ConvertFrom-Json převést řetězec ve formátu JSON na objekt JSON, který se snadno spravuje ve Windows 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

PS C:\> (Get-UICulture).Calendar | ConvertTo-Json

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

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

Příklad 2

PS C:\> @{Account="User01";Domain="Domain01";Admin="True"} | ConvertTo-Json -Compress

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

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

Příklad 3

PS C:\> 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 formátovaný 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í řetězec JSON, který vrácený ConvertTo-Json.

Příklad 4

PS C:\> Get-Date | Select-Object -Property * | ConvertTo-Json | ConvertFrom-Json

DisplayHint : 2
DateTime    : Saturday, October 13, 2018 3:28:40 AM
Date        : 10/13/2018 12:00:00 AM
Day         : 13
DayOfWeek   : 6
DayOfYear   : 286
Hour        : 3
Kind        : 2
Millisecond : 346
Minute      : 28
Month       : 10
Second      : 40
Ticks       : 636749981203464381
TimeOfDay   : @{Ticks=125203464381; Days=0; Hours=3; Milliseconds=346; Minutes=28; Seconds=40;
              TotalDays=0.14491141710763888; TotalHours=3.4778740105833332; TotalMilliseconds=12520346.4381;
              TotalMinutes=208.67244063500002; TotalSeconds=12520.3464381}
Year        : 2018

Tento příklad ukazuje, jak pomocí rutin ConvertTo-Json 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.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Depth

Určuje, kolik úrovní obsažených objektů je součástí reprezentace JSON. Výchozí hodnota je 2.

Vlastnosti parametru

Typ:Int32
Default value:2
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů: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é převést na ConvertTo-Json.

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

Vlastnosti parametru

Typ:Object
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:0
Povinné:True
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

Object

Libovolný objekt můžete převést na ConvertTo-Json .

Výstupy

String

Poznámky