Azure / Azure/azure-cli

[Reference feedback]: az servicebus namespace authorization-rule keys renew | `--key-value` parameter description is illegible

Open
#30,497 2 comments 0 reactions 0 assignees View on GitHub
act-observability-squad Auto-Assign needs-triage Service Attention Service Bus
Dominant language
Python
Stars
4.6k
Forks
3.5k
Avg merge
3d 2h
Merged PRs (30d)
60

Description

### Type of issue

Other (describe below)

### Reference command name

az servicebus namespace authorization-rule keys renew

### Request to engineering
1. Please rewrite the parameter description for `--key-value` so it is easier to understand.
2. Provide and example that uses the `--key-value` parameter

### Feedback

This GitHub issue is being moved from MicrosoftDocs/azure-docs-cli [4779](https://github.com/MicrosoftDocs/azure-docs-cli/issues/4779).
*****************************
### Type of issue

Typo

### Feedback

Seen in the `az servicebus namespace authorization-rule keys renew` section of the page.
The `--key-value` parameter description is very confusing. I've been trying, but personally I cannot make out a legible sentence from what it is trying to say. Maybe it has been incorrectly copy+pasted into?
> Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType.

It is not possible to understand how to use the parameter from this description, and there is no example using it either.
Please can this description be corrected?

### Page URL

https://learn.microsoft.com/en-us/cli/azure/servicebus/namespace/authorization-rule/keys?view=azure-cli-latest

### Content source URL

https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/servicebus/namespace/authorization-rule/keys.yml

### Author

_No response_

### Document Id

78a5f641-bea0-83d7-c328-b708c5d6f490

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.