ConvertFrom-Json

ConvertFrom-Json
    [-InputObject] <String>
    [-AsHashtable]
    [-DateKind <JsonDateKind>]
    [-Depth <Int32>]
    [-NoEnumerate]
    [<CommonParameters>]

ConvertFrom-Json Cmdlet 會將 JavaScript 物件表示法 （JSON） 格式化的字串轉換成自定義 PSObject 或 Hashtable 物件，該物件具有 JSON 字串中每個字段的屬性。 網站通常會使用 JSON 來提供物件的文字表示法。 Cmdlet 會在處理 JSON 字串的每一行時，將屬性新增至新的物件。

JSON 標準允許重複的索引鍵名稱，這些名稱在 PSObject 和 哈希表 類型中禁止。 例如，如果 JSON 字串包含重複的索引鍵，則此 Cmdlet 只會使用最後一個索引鍵。 請參閱下列其他範例。

若要從任何對象產生 JSON 字串，請使用 ConvertTo-Json Cmdlet。

此 Cmdlet 已在 PowerShell 3.0 中引進。

此命令會使用 ConvertTo-Json 和 ConvertFrom-Json Cmdlet，將 DateTime 物件從 Get-Date Cmdlet 轉換成 JSON 物件，然後轉換成 PSCustomObject。

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

DisplayHint : 2
DateTime    : Monday, January 29, 2024 3:10:26 PM
Date        : 1/29/2024 12:00:00 AM
Day         : 29
DayOfWeek   : 1
DayOfYear   : 29
Hour        : 15
Kind        : 2
Millisecond : 931
Microsecond : 47
Nanosecond  : 600
Minute      : 10
Month       : 1
Second      : 26
Ticks       : 638421378269310476
TimeOfDay   : @{Ticks=546269310476; Days=0; Hours=15; Milliseconds=931; Microseconds=47;
              Nanoseconds=600; Minutes=10; Seconds=26; TotalDays=0.632256146384259;
              TotalHours=15.1741475132222; TotalMilliseconds=54626931.0476;
              TotalMicroseconds=54626931047.6; TotalNanoseconds=54626931047600;
              TotalMinutes=910.448850793333; TotalSeconds=54626.9310476}
Year        : 2024

此範例會使用 Select-Object Cmdlet 來取得 DateTime 物件的所有屬性。 它會使用 ConvertTo-Json Cmdlet，將 DateTime 物件轉換成格式化為 JSON 物件的字串，而 ConvertFrom-Json Cmdlet 將 JSON 格式化的字串轉換成 PSCustomObject 物件。

此命令會使用 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，其會自動將 JSON 內容轉換成物件。

此範例示範如何使用 ConvertFrom-Json Cmdlet 將 JSON 檔案轉換成 PowerShell 自定義物件。

Get-Content -Raw JsonFile.json | ConvertFrom-Json

命令會使用 Get-Content Cmdlet 來取得 JSON 檔案中的字串。 Raw 參數會以單一 JSON 物件的形式傳回整個檔案。 然後，它會使用管線運算符，將分隔字串傳送至 ConvertFrom-Json Cmdlet，以將它轉換成自定義物件。

此命令展示一個範例，其中 -AsHashtable 開關可以克服命令的限制。

'{ "key":"value1", "Key":"value2" }' | ConvertFrom-Json -AsHashtable

JSON 字串包含兩個索引鍵值組，其索引鍵在大小寫上只不同。 如果沒有開關，命令就會顯示錯誤。

此命令顯示一個範例，其中 -NoEnumerate 開關被用來雙向處理單一元素 JSON 格式陣列。

Write-Output "With -NoEnumerate: $('[1]' | ConvertFrom-Json -NoEnumerate | ConvertTo-Json -Compress)"
Write-Output "Without -NoEnumerate: $('[1]' | ConvertFrom-Json | ConvertTo-Json -Compress)"

With -NoEnumerate: [1]
Without -NoEnumerate: 1

JSON 字串包含具有單一元素的陣列。 如果沒有開關，將 JSON 轉換為 PSObject，然後使用 ConvertTo-Json 命令將其轉換回來，結果會是單一的整數。

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

您可以將 JSON 字串傳送至 ConvertFrom-Json。

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

從 PowerShell 6 開始，ConvertTo-Json 嘗試將格式化為時間戳的字串轉換成 DateTime 值。

PowerShell 7.5 新增了 DateKind 參數，可讓您控制時間戳字串的轉換方式。 參數接受下列值：

• Default - 根據下列規則，將時間戳轉換成 [datetime] 實例：
  • 如果輸入字串中沒有時區資訊，Json.NET 串行化程式會將值轉換成未指定的時間值。
  • 如果時區資訊是尾端 Z，則 Json.NET 串行化程式會將時間戳轉換成 UTC 值。
  • 如果時間戳包含 UTC 位移，例如 +02:00，則會將位移轉換成呼叫端設定的時區。 默認輸出格式不會指出原始時區位移。
• Local - 將時間戳轉換為 [datetime] 時間中的 實例。 如果時間戳包含 UTC 位移，則會將位移轉換成呼叫端設定的時區。 默認輸出格式不會指出原始時區位移。
• Utc - 以 UTC 時間將值轉換成 [datetime] 實例。
• Offset - 將時間戳轉換為 [DateTimeOffset] 實例，並在該實例中保留原始字串的時區偏移。 如果原始字串未包含時區位移，則會在本機時區中指定 DateTimeOffset 值。
• String - 保留 [string] 實例的值。 這可確保任何自定義剖析邏輯都可以套用至原始字串值。

PSObject 類型會維護 JSON 字串中所呈現的屬性順序。 從 PowerShell 7.3 開始，AsHashtable 參數會建立 OrderedHashtable。 索引鍵/值組會以 JSON 字串中顯示的順序新增。 OrderHashtable 會保留該順序。