search

Azure / azure-cli

Azure Command-Line Interface
MIT License
3.97k stars 2.95k forks source link

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

Open dbradish-microsoft opened 1 month ago

dbradish-microsoft commented 1 month ago

[!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

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

yonzhan commented 1 month ago

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

github-actions[bot] commented 1 month ago

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

microsoft-github-policy-service[bot] commented 1 month ago

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