search

Azure / azure-cli

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

az redisenterprise | missing examples in reference content #29664

Open dbradish-microsoft opened 1 month ago

dbradish-microsoft commented 1 month ago

Describe the bug

Bug category:

Missing information

Request:

The Azure CLI reference guidelines specifiy at least two examples for each command. Please review the Azure CLI reference guidelines for examples and parameters and add missing content to your source code.

If a parameter accepts JSON content, provide a JSON example in the parameter long or short summary, or in a separate code block.

Issue summary:

Understanding that not all “create” commands directly generate Microsoft revenue, every “create” or “add” minimally make a revenue-producing Azure resource possible. Consequently, create commands are the most important examples to add. Of secondary importance are reference commands with complex parameters (JSON, YAML, URLs, complex Azure resource IDs, multi-valued lists, key:value pairs, conditional parameters, parameter pairs ...).

Command list without examples:

Reference name Parameter count is Create
az redisenterprise database create 11 yes
az redisenterprise database delete 6
az redisenterprise database export 6
az redisenterprise database flush 6
az redisenterprise database force-unlink 6
az redisenterprise database import 6
az redisenterprise database list 2
az redisenterprise database list-keys 4
az redisenterprise database regenerate-key 6
az redisenterprise database show 4
az redisenterprise database update 12
az redisenterprise database wait 11
az redisenterprise delete 6
az redisenterprise list 1
az redisenterprise show 4
az redisenterprise update 19
az redisenterprise wait 11

Related command

az redisenterprise

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Azure CLI 2.63.0

Additional context

No response

yonzhan commented 1 month ago

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

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 @shariq-mcs, @MSFTeegarden.

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 @shariq-mcs, @MSFTeegarden.