[Role] az ad app permission list/grant: Refine error message when no associated Service Principal exists for the App #17051
Conversation
This file contains hidden or 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
jiasli
requested review from
evelyn-ys,
fengzhou-msft and
jsntcy
as code owners
jiasli
commented
Feb 23, 2021
Comment on lines
-857
to
-858
| grant_info = graph_client.oauth2_permission_grant.list(filter=query_filter) | ||
| except CloudError as ex: # Graph doesn't follow the ARM error; otherwise would be caught by msrest-azure |
Member
Author
There was a problem hiding this comment.
list returns a Paged object which calls REST API lazily, so this except CloudError will never be hit.
Collaborator
|
Role |
Comment on lines
+862
to
+865
| raise CLIError("Service principal with appId or objectId '{id}' doesn't exist. " | ||
| "If '{id}' is an appId, make sure an associated service principal is created " | ||
| "for the app. To create one, run `az ad sp create --id {id}`." | ||
| .format(id=client_sp_object_id)) |
Member
There was a problem hiding this comment.
Shall we use a UserFault type error here?
Member
There was a problem hiding this comment.
InvalidArgumentValueError for example
Member
Author
There was a problem hiding this comment.
This is rather complex here as client_sp_object_id is indeed a valid appId but the app doesn't have associated SP. This command group is already considered deprecated (implicitly) anyway.
evelyn-ys
approved these changes
Mar 18, 2021
fengzhou-msft
approved these changes
Mar 18, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
Close #16862:
az ad app permission grantfails with ResourceNotFoundErrorWhen calling
az ad app permission list/granton an App without associated Service Principal, CLI fails with a raw error.This PR refines the error message to tell the user to create a Service Principal instead.
Testing Guide
Before:
After: