{"id":9602,"date":"2024-05-08T07:03:46","date_gmt":"2024-05-08T07:03:46","guid":{"rendered":"https:\/\/cheapwindowsvps.com\/blog\/guide-to-reading-modifying-and-parsing-json-files-with-powershell\/"},"modified":"2025-01-20T09:38:03","modified_gmt":"2025-01-20T09:38:03","slug":"guide-to-reading-modifying-and-parsing-json-files-with-powershell","status":"publish","type":"post","link":"https:\/\/cheapwindowsvps.com\/blog\/guide-to-reading-modifying-and-parsing-json-files-with-powershell\/","title":{"rendered":"Guide to Reading, Modifying, and Parsing JSON Files with PowerShell"},"content":{"rendered":"

JSON is a popular text-based format for representing and transmitting structured data based on JavaScript object syntax. There are two cmdlets in PowerShell that allow you to work with the JSON data format: ConvertFrom-Json<\/code> and ConvertTo-Json<\/code>. Let\u2019s look at how you can use PowerShell to create, read, or modify JSON objects and save them to files.<\/p>\n<\/p>\n

Data in JSON format is represented as key:value<\/strong> pairs (property nesting is allowed). Suppose you want to write JSON data to a file. Create a JSON structured data object:<\/p>\n<\/p>\n

<\/p>
$obj = @{<\/p>
    Name = \"Henry\"<\/p>
    Roles = @{<\/p>
          AD = \"Admin\"<\/p>
          SQL = \"Report\"<\/p>
      }<\/p>
      \"Company\" = \"woshub\"<\/p>
  }<\/pre>\n<\/p>\n
Now convert the object to JSON format and save it to a file with a .json<\/strong> extension:<\/p>\n<\/p>\n
$json = $obj | ConvertTo-Json<\/p>
$json | Set-Content -Path C:PSuserroles.json<\/code><\/pre>\n<\/p>\n
You can now read the JSON file:<\/p>\n<\/p>\n
$json = Get-Content -Path C:PSuserroles.json -Raw | ConvertFrom-Json<\/code><\/pre>\n<\/p>\n
\n<\/div>\n
List all JSON object properties:<\/p>\n<\/p>\n
$json|fl<\/code><\/p>\n<\/p>\n
Or you can get the value of a particular property in a JSON object:<\/p>\n<\/p>\n
$json.roles.sql<\/code><\/p>\n<\/p>\n
Use the Add-Member<\/strong> command to add a new property to a JSON object:<\/p>\n<\/p>\n
$json| Add-Member -MemberType NoteProperty -Name \"Email\" -Value \"[email protected]<\/a>\"<\/code><\/p>\n<\/p>\n
Use the following commands to change a single value in a JSON object and save it to a file:<\/p>\n<\/p>\n
<\/p>
<code><\/p>
$json.roles.sql='Admin';<\/p>
$json|ConvertTo-Json| Set-Content -Path C:PSuserroles.json<\/p>
<\/code><\/p>
<\/pre>\n<\/p>\n
Remove JSON object property:<\/p>\n<\/p>\n
<\/p>
<code><\/p>
$json.PSObject.Properties.Remove(\"Email\")<\/p>
<\/code><\/p>
<\/pre>\n<\/p>\n
By utilizing the Invoke-WebRequest<\/a> PowerShell command, JSON HTTP API data can be retrieved from external web services or websites. As an example, A records returned by Google’s DNS service in JSON format can be listed:<\/p>\n<\/p>\n
$site=\"woshub.com\"
 $rawresp=Invoke-WebRequest \"https:\/\/dns.google\/resolve?name=$site&type=A\"
 $rawjson = ConvertFrom-Json -InputObject $rawresp.Content
 $rawjson.answer.data<\/code><\/p><\/p>\n","protected":false},"excerpt":{"rendered":"
JSON is a popular text-based format for representing and transmitting structured data based on JavaScript object syntax. There are two cmdlets in PowerShell that allow you to work with the JSON data format: ConvertFrom-Json and ConvertTo-Json. Let\u2019s look at how you can use PowerShell to create, read, or modify JSON objects and save them to […]<\/p>\n","protected":false},"author":1,"featured_media":9603,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[117],"tags":[],"class_list":["post-9602","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell"],"_links":{"self":[{"href":"https:\/\/cheapwindowsvps.com\/blog\/wp-json\/wp\/v2\/posts\/9602","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/cheapwindowsvps.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/cheapwindowsvps.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/cheapwindowsvps.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/cheapwindowsvps.com\/blog\/wp-json\/wp\/v2\/comments?post=9602"}],"version-history":[{"count":2,"href":"https:\/\/cheapwindowsvps.com\/blog\/wp-json\/wp\/v2\/posts\/9602\/revisions"}],"predecessor-version":[{"id":10298,"href":"https:\/\/cheapwindowsvps.com\/blog\/wp-json\/wp\/v2\/posts\/9602\/revisions\/10298"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/cheapwindowsvps.com\/blog\/wp-json\/wp\/v2\/media\/9603"}],"wp:attachment":[{"href":"https:\/\/cheapwindowsvps.com\/blog\/wp-json\/wp\/v2\/media?parent=9602"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/cheapwindowsvps.com\/blog\/wp-json\/wp\/v2\/categories?post=9602"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/cheapwindowsvps.com\/blog\/wp-json\/wp\/v2\/tags?post=9602"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}