[Core] Improve Error Message For Json Decode Errors

[kashifkhan]

We want to improve the error message that is raised from Azure Core when it encounters json decoding errors. As these errors are typically coming from the service we should

• Let the user know that the error is coming from the service versus our default error message
• The error message can also include common things the user should check or do and also include a link to where the customer can open a ticket with the service.

This will aide users of the SDK on what next steps are and what could be causing this.

[github-actions]

@kashifkhan @xiangyan99

[github-actions]

Hello @kashifkhan. I'm an AI assistant for the azure-sdk-for-python repository. I have some suggestions that you can try out while the team gets back to you.

• Consider updating the error message so it clearly indicates that the JSON decoding failure is due to a response payload from the service, rather than a default SDK error.

• Include a short checklist in the error message advising customers to:

• Verify the validity of the JSON payload returned by the service.
• Check network connectivity and confirm that the service is up and running.
• Inspect the response headers and status code for additional clues.

• Embed a link in the error message (or documentation) pointing to the appropriate service issue tracker (for example, the Azure REST API Specs Issues) so that users can quickly escalate if the problem persists.

These improvements should help users isolate if the error is coming from the service or due to local issues, and guide them towards potential resolutions.

The team will get back to you shortly, hopefully this helps in the meantime.