Skip to content

{AD} az ad: Update --filter argument's help message #25172

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
Draft

{AD} az ad: Update --filter argument's help message #25172

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
4 changes: 3 additions & 1 deletion src/azure-cli/azure/cli/command_modules/role/_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,9 @@ def load_arguments(self, _):
c.argument('identifier_uri', help='graph application identifier, must be in uri format')
c.argument('spn', help='service principal name')
c.argument('upn', help='user principal name, e.g. [email protected]')
c.argument('query_filter', options_list=['--filter'], help='OData filter, e.g. --filter "displayname eq \'test\' and servicePrincipalType eq \'Application\'"')
c.argument('query_filter', options_list=['--filter'],
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')
Comment on lines +238 to +239
Copy link
Member Author

@jiasli jiasli Jan 19, 2023

Choose a reason for hiding this comment

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

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.

Comment on lines +238 to +239
Copy link
Member Author

@jiasli jiasli Jan 19, 2023

Choose a reason for hiding this comment

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

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.


with self.argument_context('ad user') as c:
c.argument('mail_nickname', help='mail alias. Defaults to user principal name')
Expand Down