Azure / Azure/azure-cli

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

Open
#29,492 3 comments 0 reactions 0 assignees View on GitHub
act-codegen-extensibility-squad bug Search Service Attention Similar-Issue
Dominant language
Python
Stars
4.6k
Forks
3.5k
Avg merge
3d 2h
Merged PRs (30d)
60

Description

[!NOTE] Part of this GitHub issue was reported on 2024-02-01 in issue [28290](https://github.com/Azure/azure-cli/issues/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](https://github.com/user-attachments/assets/2cd38c45-539a-4d36-9faf-6b6a77ea7cc9)

### 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_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.