{AD} az ad: Update --filter argument's help message#25172
Draft
{AD} az ad: Update --filter argument's help message#25172
az ad: Update --filter argument's help message#25172Conversation
ghost
requested a review
from 
ghost
added
the
Graph
jiasli
commented
Jan 19, 2023
Comment on lines
+238
to
+239
| help='The $filter OData query parameter to retrieve a subset of a collection. ' | ||
| 'For more information, see https://learn.microsoft.com/graph/filter-query-parameter') |
Member
Author
There was a problem hiding this comment.
This topic is quite similar to the one we are having on --query: #24633 (comment), #24332 (comment). That is, whether we want to provide concrete examples for generic arguments in each command.
jiasli
commented
Jan 19, 2023
Comment on lines
+238
to
+239
| help='The $filter OData query parameter to retrieve a subset of a collection. ' | ||
| 'For more information, see https://learn.microsoft.com/graph/filter-query-parameter') |
Member
Author
There was a problem hiding this comment.
Another thing is how we can better convey that quoting rules should be considered in different shells. Especially, when there are spaces in the value, the value should be quoted.
Currently --query doesn't mention quoting rules.
--query : JMESPath query string. See http://jmespath.org/ for more information and
examples.
Collaborator
|
Update |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Related command
az adDescription
--filteris defined on the wholeaz adscope, so whenever a command underaz adsupports--filter, the help message shows the same example:azure-cli/src/azure-cli/azure/cli/command_modules/role/_params.py
Line 232 in ce44693
azure-cli/src/azure-cli/azure/cli/command_modules/role/_params.py
Line 237 in ce44693
The current example
--filter "displayname eq 'test' and servicePrincipalType eq 'Application'"only works foraz ad sp list, but doesn't work foraz ad app listaz ad app permission list-grantsaz ad user listaz ad group listThis PR updates the help message of
--filterto a generic one that suits all commands that supports--filter.