PowerShell Genie

ConvertFrom-Json

Use ConvertFrom-Json to convert a JSON-formatted string to a PowerShell object. See Microsoft.PowerShell.Utility module requirements and examples.

Command 1 min read Windows PowerShell 5.1 and PowerShell 7

Documentation: Microsoft Learn — ConvertFrom-Json

Syntax

1PS> ConvertFrom-Json [-InputObject] <String> [-Depth <Int32>] [<CommonParameters>]
See the command anatomy

Read the command and its supplied arguments. This example requires real PowerShell or its module; this diagram does not execute it.

ConvertFrom-Json [-InputObject] <String> [-Depth <Int32>] [<CommonParameters>]
  1. Stage 1ConvertFrom-Json-InputObject -Depth

    Try it

    Windows PowerShell

    PowerShell example · browser support is limited.

    Execution scope: The full example below requires PowerShell outside this browser. You can edit this runner to use the supported practice commands; unsupported syntax returns an explanation.

    Interactive simulation · fictional data

    Examples

    Get-Content -Raw |

    1PS> Get-Content C:\Config\settings.json -Raw | ConvertFrom-Json
    Show reference output

    Sample output · fictional data, shaped like the real thing

    Name      Status   Port
    ----      ------   ----
    Server01  Healthy  443

    Parameters

    Parameter definitions:

    • -InputObject
    • -Depth

    ConvertFrom-Json on Microsoft Learn

    Practical use and troubleshooting

    Practical scenario: Use ConvertFrom-Json when you need to convert a JSON-formatted string to a PowerShell object. Start with one identified target and inspect the returned values before extending the operation to a list. Keep the identity in your report so you can trace each result back to the object or path that produced it.

    Common error and fix: A conversion error often means the input is not valid JSON. Read a file as one string with Get-Content -Raw, check quoting and separators, and do not silently replace invalid input with an empty object. In an unattended script, capture this failure with its original error record and record which target failed. An empty result and an unsuccessful query must remain distinguishable in the final report.

    See also: ConvertTo-Json. ConvertTo-Json serializes PowerShell values to JSON text; ConvertFrom-Json parses JSON into values. Keep the original object when later stages need typed properties rather than serialized text. Read the linked command before substituting it; similar names do not imply identical inputs or output.

    ConvertFrom-Json reference on Microsoft Learn

    Recap

    ConvertFrom-Json Use ConvertFrom-Json to convert a JSON-formatted string to a PowerShell object. See Microsoft.PowerShell.Utility module requirements and examples.

    Next: ConvertTo-Json
    Genie guideConvertFrom-Json

    Use ConvertFrom-Json to convert a JSON-formatted string to a PowerShell object. The console below is pre-loaded — run it, then change a value and run it again.