Invoke-RestMethod should have an -AsHashTable switch

[iRon7]

Summary of the new feature / enhancement

For the same reason as ConvertFrom-Json has an -AsHashTable parameter (see: #3159), Invoke-RestMethod should have an -AsHashTable switch to convert to a HashTable (or an OrderedHashTable)

See e.g.: powershell add key value to the json

Proposed technical implementation details (optional)

No response

[jhoneill]

This would be useful. Somewhere - I can't remember where - I had to write code to convert the object returned back to hash table.

[CarloToso]

Related #7880

[BrucePay]

What happens when the payload is NOT JSON?

[iRon7]

@BrucePay,

What happens when the payload is NOT JSON?

I guess a simple warning as:

WARNING: Cannot convert, or deserialize, the returned content into a HashTable

and returning the content "as is", will be sufficient.

In general, I don't see any issue when a potential -AsHashTable switch is given and it is able to convert it into a [PSCustomObject] to convert it into a [OrderedHashTable] instead.
Meaning:

PowerShell formats the response based to the data type. For an RSS or ATOM feed, PowerShell returns the Item or
Entry XML nodes. For JavaScript Object Notation (JSON) or XML, PowerShell converts, or deserializes, the content
into [PSCustomObject] objects or an [OrderedHashTable] in case the -AsHashTable switch is set.

[SteveL-MSFT]

XML could be converted to a hashtable, but I suspect no one actually wants that. Perhaps in this case such a switch needs to be more explicit like -JsonAsHashtable where it's documented that it's a no-op if not JSON?

[iRon7]

Please either mark this issue with something like Resolution-Declined or put it on a kind of wishlist "Issue we would like to prioritize, but we can't commit we will get to it yet"

[nkasco]

XML could be converted to a hashtable, but I suspect no one actually wants that. Perhaps in this case such a switch needs to be more explicit like -JsonAsHashtable where it's documented that it's a no-op if not JSON?

I'm good with this. Just ran into this and while I can just pipe the result into ConvertFrom-JSON -AsHashTable, would be clean to do all upfront.

Is there a performance or data hit if you use it when you don't need to? (like it there aren't duplicate keys with different spellings?)
@SteveL-MSFT