ConvertTo-Json

参考

模块:: Microsoft.PowerShell.Utility

将对象转换为 JSON 格式的字符串。

语法

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

说明

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-Json 的 Compress 参数的效果。压缩仅影响字符串的外观，而不会影响其有效性。

示例 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 类实现的。

通过