search

Azure / azure-cli-extensions

Public Repository for Extensions of Azure CLI.
https://docs.microsoft.com/en-us/cli/azure
MIT License
382 stars 1.23k forks source link

az confluent | missing examples in reference content #8075

Open dbradish-microsoft opened 2 months ago

dbradish-microsoft commented 2 months 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 ...).

Subgroups with no examples:

Note: The commands for these subgroups are in the second table (below). Page views (PVs) for a subgroup are "the sum of all PVs for every autogenerated reference doc in that subgroup." When there is > 1 command in a single GitHub file, the same PV amount is counted for both commands. PVs are being provided as a general idea of customer interest.

Subgroup name Status Command count 6 month PVs
az confluent organization api-key GA 1
az confluent organization environment GA 1 17
az confluent organization environment cluster GA 3 10
az confluent organization environment schema-registry-cluster GA 2
az confluent organization role-binding GA 1 7

Reference commands with no examples:

Note: Some of these command subgroups have at least one example. This table is a list of all az batch commands with no example. PV values repeat when one GitHub file contains > 1 reference command. PVs are being provided as a general idea of customer interest.

Reference name Parameter count is Create 6 month PVs
az confluent organization api-key delete 6
az confluent organization create-role-binding 7 yes 163
az confluent organization create-user 9 yes 163
az confluent organization environment cluster create-api-key 8 yes 10
az confluent organization environment cluster list 7 10
az confluent organization environment cluster show 6 10
az confluent organization environment list 6 17
az confluent organization environment schema-registry-cluster list 7
az confluent organization environment schema-registry-cluster show 6
az confluent organization list-role-binding 5 163
az confluent organization list-service-accounts 5 163
az confluent organization list-users 5 163
az confluent organization role-binding delete 6 7

Related command

az confluent

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 2 months ago

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