Skip to content
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.

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

Customer feedback | az search service create | Parameter short summaries are incomplete #29492

Open
dbradish-microsoft opened this issue Jul 26, 2024 · 3 comments
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Search Service Attention This issue is responsible by Azure service team. Similar-Issue

Comments

@dbradish-microsoft
Copy link
Contributor

dbradish-microsoft commented Jul 26, 2024

[!NOTE] Part of this GitHub issue was reported on 2024-02-01 in issue 28290. The duplicate parameter name and description of --identity-name is new here.

Feedback category

  • Missing / incorrect parameter information

Reference command

az connectedmachine extension create

Summary

From Learn Customer Feedback, it looks like we have some incomplete short description parameter values. Please see screen print below.

Doc link

https://learn.microsoft.com/en-us/cli/azure/search/service?view=azure-cli-latest#az-search-service-create-optional-parameters

Customer feedback

Customer #1

"
The information in the Parameters section is in several places lacking sufficient information to be able to properly use the command. For example, "Some help" is used twice, and "The identity type" for the --identity-type option.
"

Customer #2

"
Note that the "--ip-rules" section only has the comment "some help." Looks like it might have been a placeholder that was overlooked.
"

Screen print

image

Related command

az search service create

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Screen print captured from Azure CLI 2.62.0

Additional context

No response

@dbradish-microsoft dbradish-microsoft added the bug This issue requires a change to an existing behavior in the product in order to be resolved. label Jul 26, 2024
@yonzhan
Copy link
Collaborator

yonzhan commented Jul 26, 2024

Thank you for opening this issue, we will look into it.

Copy link

Here are some similar issues that might help you. Please check if they can solve your problem.

@yonzhan yonzhan added Service Attention This issue is responsible by Azure service team. Search labels Jul 27, 2024
Copy link
Contributor

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @bleroy, @tjacobhi, @MarkHeff, @miwelsh.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Search Service Attention This issue is responsible by Azure service team. Similar-Issue
Projects
None yet
Development

No branches or pull requests

2 participants