Skip to content

{AD} Show error code for Microsoft Graph errors #29941

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jiasli wants to merge 1 commit into
base: dev
Choose a base branch
from
+5 −1
Draft

{AD} Show error code for Microsoft Graph errors #29941

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/azure-cli/azure/cli/command_modules/role/_msgrpah/_graph_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,11 @@ def _send(self, method, url, param=None, body=None, api_version=V1_0):
r = send_raw_request(self._cli_ctx, method, url, resource=self._resource, uri_parameters=param,
body=body)
except HTTPError as ex:
raise GraphError(ex.response.json()['error']['message'], ex.response) from ex
# https://learn.microsoft.com/en-us/graph/errors#error-resource-type
error = ex.response.json()['error']
code = error['code']
message = error['message']
raise GraphError(f"({code}) {message}", ex.response) from ex
Copy link
Copy Markdown
Member

@evelyn-ys evelyn-ys Sep 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will code and message always exist? Should we use err.get('Code', '')?

Copy link
Copy Markdown
Member Author

@jiasli jiasli Sep 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will code and message always exist?

A good catch! I can't guarantee this. Using .get() is definitely more robust.

But, we can't use err.get('code', ''). If code does exist but is null, it will be rendered as 'None'. https://docs.python.org/3.12/library/stdtypes.html#dict.get

It's better to use err.get('code') or ''.

Copy link
Copy Markdown
Member Author

@jiasli jiasli Sep 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait. code and message are guaranteed to exist: https://learn.microsoft.com/en-us/graph/errors#error-resource-type

image

# Other exceptions like AuthenticationError should not be handled here, so we don't catch CLIError

if r.text:
Expand Down
Loading