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]
              [-EnumsAsStrings]
              [-AsArray]
              [-EscapeHandling <StringEscapeHandling>]
              [<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.

Poznámka:

Od PowerShellu 7.2 se vlastnosti rozšířeného systému typů objektů DateTime a String už serializují a pouze jednoduchý objekt se převede na formát JSON.

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.

Od PowerShellu 7.1 vygeneruje upozornění, ConvertTo-Json pokud hloubka vstupního objektu překročí hloubku zadanou pro příkaz. Tím zabráníte nežádoucí ztrátě dat při převodu objektů.

Tato rutina byla zavedena ve Windows PowerShellu 3.0.

Příklady

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

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

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

Tento příklad ukazuje výstup rutiny ConvertTo-Json s parametrem přepínače AsArray a bez. Uvidíte, že druhá část výstupu je zabalená v hranatých závorkách.

Příklad 3

@{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 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
}

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

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

Parametry

-AsArray

Vypíše objekt v hranatých závorkách, i když je vstup jedním objektem.

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

-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 0 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

-EnumsAsStrings

Poskytuje alternativní serializační možnost, která převede všechny výčty na jejich řetězcové vyjádření.

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

-EscapeHandling

Určuje, jak jsou určité znaky ve výsledném výstupu JSON uchycené. Ve výchozím nastavení jsou řídicí znaky (například nový řádek) řídicí znaky.

Přijatelné hodnoty jsou:

  • Výchozí – Řídicí znaky jsou řídicí znaky řídicí znaky.
  • EscapeNonAscii – Všechny znaky, které nejsou ASCII a ovládacími znaky, jsou řídicí znaky.
  • EscapeHtml - HTML (<, >, &, ', ") a řídicí znaky jsou řídicí znaky.

Tento parametr byl představen v PowerShellu 6.2.

Type:Newtonsoft.Json.StringEscapeHandling
Position:Named
Default value:Default
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 vrátí reprezentaci nullJSON . Pokud je vstupním objektem prázdný řetězec, ConvertTo-Json vrátí reprezentaci JSON prázdného řetězce.

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í newtonsoft Json.NET.