{AD} Show error code for Microsoft Graph errors #29941
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
️✔️AzureCLI-FullTest
|
|
Hi @jiasli, |
️✔️AzureCLI-BreakingChangeTest
|
|
AD |
microsoft-github-policy-service
bot
requested review from
evelyn-ys,
calvinhzy,
yonzhan and
zhoxing-ms
microsoft-github-policy-service
bot
added
the
ARM
|
I am hesitating on ARM clients' implementation is from def __str__(self) -> str:
return "({}) {}\n{}".format(self.code, self.message, self.message_details())
def message_details(self) -> str:
"""Return a detailed string of the error.
:return: A string with the details of the error.
:rtype: str
"""
error_str = "Code: {}".format(self.code)
error_str += "\nMessage: {}".format(self.message)
if self.target:
error_str += "\nTarget: {}".format(self.target)
if self.details:
error_str += "\nException Details:"
for error_obj in self.details:
# Indent for visibility
error_str += "\n".join("\t" + s for s in str(error_obj).splitlines())
if self.innererror:
error_str += "\nInner error: {}".format(json.dumps(self.innererror, indent=4))
return error_strI guess the reason is because besides Even though Graph error also contains similar properties, such as # az ad sp credential reset --id 92375e31-0eae-4019-8207-0698ce16d144 --verbose
{
"error": {
"code": "CannotUpdateLockedServicePrincipalProperty",
"message": "Property passwordCredentials is invalid.",
"details": [
{
"code": "GenericError",
"message": "Property passwordCredentials is invalid.",
"target": "passwordCredentials",
"blockedWord": "",
"prefix": "",
"suffix": ""
}
],
"innerError": {
"date": "2024-09-20T08:01:41",
"request-id": "fbbd7cdb-8181-4bcf-8bca-7ed896035ee2",
"client-request-id": "fbbd7cdb-8181-4bcf-8bca-7ed896035ee2"
}
}
}It may not be guaranteed that the error body of every API is the same, so I tend to only show the top level |
evelyn-ys
reviewed
Sep 20, 2024
| err = ex.response.json()['error'] | ||
| code = err['code'] | ||
| message = err['message'] | ||
| raise GraphError(f"({code}) {message}", ex.response) from ex |
There was a problem hiding this comment.
Will code and message always exist? Should we use err.get('Code', '')?
There was a problem hiding this comment.
Will
codeandmessagealways 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 ''.
There was a problem hiding this comment.
Wait. code and message are guaranteed to exist: https://learn.microsoft.com/en-us/graph/errors#error-resource-type
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related command
az adaz roleDescription
The current Graph client only shows
error.messageproperty. Sometimes,error.codealso contains valuable information. For example, in #28734, the error code is more clear than the error message:ARM clients show error code in parentheses and then the error message. They are also repeated in
Code:andMessage:lines:This PR aligns Graph client with ARM client but without
Code:andMessage:lines: