Unwanted transform to add resource_group in properties having 'id' object

[JainRah]

Related command

az network virtual-appliance show

Is your feature request related to a problem? Please describe.

Yes,
Output of PS, az-cli and rest api should match.
Expected:
"virtualHub": {
"id": "/subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/RahulTestSetup/providers/Microsoft.Network/virtualHubs/RahulTestHub"
},

Error Output
"virtualHub": {
"id": "/subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/RahulTestSetup/providers/Microsoft.Network/virtualHubs/vHUB",
"resourceGroup": "RahulTestSetup"
}

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Attaching debug output

https://microsoft.sharepoint.com/:t:/t/NVAengineering/EVLNnkTugHhFo4vLGu_0zQUBgvdTyp_19wx7v0oxZEEyQQ?e=UAiZZV

[yonzhan]

Thank you for opening this issue, we will look into it.

[jiasli]

The logic for adding resourceGroup property to the output JSON was introduced as early as #66. It was previously reported for az rest in #16286 and was dropped for az rest in #19579. _resource_group_transform and _x509_from_base64_to_hex_transform were not dropped globally at that time simply because we don't want to make too many breaking changes.

This issue actually brings out a deeper discussion/question: Should Azure CLI as a client modify the REST API response to make it "more user-friendly"? Apparently, sometimes it is not truly user-friendly, as it causes more inconsistency issues.

A similar issue is the flattening of properties in the response JSON. As #17332 pointed out, because of the inconsistent use of x-ms-client-flatten in different resources' REST specs, SDK flattens properties for some resources while it doesn't flatten properties for other resources, leading to vast inconsistency and difficulty in documenting the command output. I previously suggested removing x-ms-client-flatten in Azure/azure-rest-api-specs#13578 but that discussion has no conclusion.