ConvertFrom-Json

模块:: Microsoft.PowerShell.Utility Module

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

语法

Default （默认值）

ConvertFrom-Json
    [-InputObject] <String>
    [<CommonParameters>]

说明

ConvertFrom-Json cmdlet 将 JavaScript 对象表示法（JSON）格式字符串转换为自定义 PSCustomObject 对象，该对象具有 JSON 字符串中每个字段的属性。网站通常使用 JSON 来提供对象的文本表示形式。 JSON 标准不禁止使用 PSCustomObject。例如，如果 JSON 字符串包含重复键，则此 cmdlet 仅使用最后一个键。请参阅以下示例。

若要从任何对象生成 JSON 字符串，请使用 ConvertTo-Json cmdlet。

PowerShell 3.0 中引入了此 cmdlet。

注释

此 cmdlet 不支持包含注释的 JSON。

示例

示例 1：将 DateTime 对象转换为 JSON 对象

此命令使用 ConvertTo-Json 和 ConvertFrom-Json cmdlet 将 DateTime 对象从 Get-Date cmdlet 转换为 JSON 对象，接着转换为 PSCustomObject。

Get-Date | Select-Object -Property * | ConvertTo-Json | ConvertFrom-Json

DisplayHint : 2
DateTime    : Friday, January 13, 2012 8:06:31 PM
Date        : 1/13/2012 8:00:00 AM
Day         : 13
DayOfWeek   : 5
DayOfYear   : 13
Hour        : 20
Kind        : 2
Millisecond : 400
Minute      : 6
Month       : 1
Second      : 31
Ticks       : 634620819914009002
TimeOfDay   : @{Ticks=723914009002; Days=0; Hours=20; Milliseconds=400; Minutes=6; Seconds=31; TotalDays=0.83786343634490734; TotalHours=20.108722472277776; TotalMilliseconds=72391400.900200009; TotalMinutes=1206.5233483366667;TotalSeconds=72391.4009002}
Year        : 2012

该示例使用 Select-Object cmdlet 获取 DateTime 对象的所有属性。它使用 ConvertTo-Json cmdlet 将 DateTime 对象转换为格式化为 JSON 对象的字符串，ConvertFrom-Json cmdlet 将 JSON 格式的字符串转换为 PSCustomObject 对象。

示例 2：从 Web 服务获取 JSON 字符串并将其转换为 PowerShell 对象

此命令使用 Invoke-WebRequest cmdlet 从 Web 服务获取 JSON 字符串，然后使用 ConvertFrom-Json cmdlet 将 JSON 内容转换为可在 PowerShell 中管理的对象。

# Ensures that Invoke-WebRequest uses TLS 1.2
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
$j = Invoke-WebRequest 'https://api.github.com/repos/PowerShell/PowerShell/issues' | ConvertFrom-Json

还可以使用 Invoke-RestMethod cmdlet，该 cmdlet 会自动将 JSON 内容转换为对象。

示例 3：将 JSON 字符串转换为自定义对象

此示例演示如何使用 ConvertFrom-Json cmdlet 将 JSON 文件转换为 PowerShell 自定义对象。

Get-Content JsonFile.JSON | ConvertFrom-Json

该命令使用 Get-Content cmdlet 获取 JSON 文件中的字符串。然后，它使用管道运算符将带分隔符的字符串发送到 ConvertFrom-Json cmdlet，该 cmdlet 将其转换为自定义对象。

参数

-InputObject

指定要转换为 JSON 对象的 JSON 字符串。输入包含字符串的变量，或键入获取字符串的命令或表达式。还可以通过管道将字符串传递给 ConvertFrom-Json。

InputObject 参数是必需的，但其值可以是空字符串。当输入对象为空字符串时，ConvertFrom-Json 不会生成任何输出。 InputObject 值不能 $null。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。有关详细信息，请参阅 about_CommonParameters。

输入

String

可以通过管道将 JSON 字符串传递给 ConvertFrom-Json。

输出

PSCustomObject

备注

ConvertFrom-Json cmdlet 是使用 JavaScriptSerializer 类实现的。

通过