ConvertTo-Json

參考

模組:: Microsoft.PowerShell.Utility

將物件轉換成 JSON 格式的字串。

語法

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

Description

ConvertTo-Json Cmdlet 會將任何 .NET 物件轉換成 JavaScript 物件表示法（JSON）格式的字串。屬性會轉換成域名、域值會轉換成屬性值，而且會移除方法。

接著，您可以使用 ConvertFrom-Json Cmdlet，將 JSON 格式的字串轉換成 JSON 物件，這可在 PowerShell 中輕鬆管理。

許多網站會使用 JSON 而不是 XML 來串行化伺服器與 Web 應用程式之間的通訊資料。

此 Cmdlet 已在 Windows PowerShell 3.0 中引進。

範例

範例 1

(Get-UICulture).Calendar | ConvertTo-Json

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

此命令會使用 ConvertTo-Json Cmdlet，將 GregorianCalendar 物件轉換成 JSON 格式字串。

範例 2

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

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

此命令會顯示使用 ConvertTo-JsonCompress 參數的效果。壓縮只會影響字串的外觀，而不會影響其有效性。

範例 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
}

這個範例會使用 ConvertTo-Json Cmdlet，將 System.DateTime 物件從 Get-Date Cmdlet 轉換為 JSON 格式字串。此命令會使用 Select-Object Cmdlet 來取得 DateTime 物件之屬性的所有（*）。輸出會顯示 ConvertTo-Json 傳回的 JSON 字串。

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

此範例示範如何使用 ConvertTo-Json 和 ConvertFrom-Json Cmdlet，將物件轉換成 JSON 字串和 JSON 物件。

參數

-Compress

省略輸出字串中的空格符和縮排格式。

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Depth

指定 JSON 表示法中包含多少個自主物件的層級。值可以是從 1 到 100的任何數位。預設值為 2。如果輸入物件中的層級數目超過這個數位，ConvertTo-Json 會發出警告。

類型:	Int32
Position:	Named
預設值:	2
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-InputObject

指定要轉換成 JSON 格式的物件。輸入包含物件的變數，或輸入取得物件的命令或表達式。您也可以使用管線將物件傳送至 ConvertTo-Json。

InputObject 參數是必要的，但其值可以是 null （$null）或空字串。當輸入物件 $null時，ConvertTo-Json 不會產生任何輸出。當輸入物件是空字串時，ConvertTo-Json 會傳回空字串。

類型:	Object
Position:	0
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

輸入

Object

您可以使用管線將任何物件傳送至此 Cmdlet。

輸出

String

此 Cmdlet 會傳回字串，代表轉換成 JSON 字串的輸入物件。

備註

ConvertTo-Json Cmdlet 是使用 JavaScriptSerializer 類別實作。

共用方式為