ConvertTo-Json

  • 參考
模組:
Microsoft.PowerShell.Utility

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

Syntax

ConvertTo-Json
              [-InputObject] <Object>
              [-Depth <Int32>]
              [-Compress]
              [-EnumsAsStrings]
              [-AsArray]
              [-EscapeHandling <StringEscapeHandling>]
              [<CommonParameters>]

Description

Cmdlet ConvertTo-Json 會將任何 .NET 物件轉換成 JavaScript 物件標記法中的字串， (JSON) 格式。 屬性會轉換成欄位名稱、欄位值會轉換成屬性值，而方法會被移除。

注意

從 PowerShell 7.2 開始， DateTime 和 String 物件的擴充類型系統屬性不再序列化，而且只會將簡單物件轉換成 JSON 格式

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

許多網站都使用 JSON 而不是 XML 來將資料序列化，以便在伺服器與 Web 應用程式之間進行通訊。

從 PowerShell 7.1 起，如果輸入物件的深度超過命令指定的深度， ConvertTo-Json 就會發出警告。 這可防止在轉換物件時遺失不必要的資料。

此 Cmdlet 是在 Windows PowerShell 3.0 中引進。

範例

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

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

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

此範例顯示 Cmdlet 的輸出 ConvertTo-Json ，以及不含 AsArray 參數。 您可以看到輸出的第二個部分會包裝在陣列括弧中。

範例 3

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

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

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

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

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

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

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

參數

-AsArray

輸出陣列括弧中的物件，即使輸入是單一物件也一樣。

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

-Compress

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

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

-Depth

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

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

-EnumsAsStrings

提供替代的序列化選項，可將所有列舉轉換成其字串表示。

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

-EscapeHandling

控制在產生的 JSON 輸出中逸出特定字元的方式。 根據預設，只會逸出新行) 之類的控制字元 (。

可接受的值如下：

  • 預設值 - 只會逸出控制字元。
  • EscapeNonAscii - 所有非 ASCII 和控制字元都會逸出。
  • EscapeHtml - 會逸出 HTML (< 、 > 、 & 、、 ') " 和控制字元。

此參數是在 PowerShell 6.2 中引進的。

Type:Newtonsoft.Json.StringEscapeHandling
Position:Named
Default value:Default
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

需要 InputObject參數，但其值可以是 null () $null 或空字串。 當輸入物件為 $null 時， ConvertTo-Json 傳回 的 null JSON 表示。 當輸入物件是空字串時， ConvertTo-Json 會傳回空字串的 JSON 表示。

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

輸入

Object

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

輸出

String

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

備註

Cmdlet ConvertTo-Json 是使用 Newtonsoft Json.NET來實作。