共用方式為

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) 格式。 屬性會轉換成欄位名稱、欄位值會轉換成屬性值，而方法會被移除。

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

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

此 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

{
  "value": "2018-10-12T23:07:18.8450248-05:00",
  "DisplayHint": 2,
  "DateTime": "October 12, 2018 11:07:18 PM"
}
[
  {
    "value": "2018-10-12T23:07:18.8480668-05:00",
    "DisplayHint": 2,
    "DateTime": "October 12, 2018 11:07:18 PM"
  }
]

此範例示範 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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Compress

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

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

-Depth

指定 JSON 表示法中包含多少層的內含物件。 預設值為 2。

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

-EnumsAsStrings

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

需要 InputObject 參數，但其值可以是 null ($null) 或空字串。 當輸入物件為 $null時， ConvertTo-Json 不會產生任何輸出。 當輸入對像是空字串時， ConvertTo-Json 會傳回空字串。

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

輸入

Object

您可以使用管線將任何物件傳送至 ConvertTo-Json。

輸出

String

備註

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