azure-cli-extensions
azure-cli-extensions copied to clipboard
az containerapp | missing examples in reference content
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 containerapp add-on | Preview | 1 | 541 |
| az containerapp add-on kafka | Preview | 2 | 132 |
| az containerapp add-on mariadb | Preview | 2 | 86 |
| az containerapp add-on milvus | Preview | 2 | 54 |
| az containerapp add-on postgres | Preview | 2 | 207 |
| az containerapp add-on qdrant | Preview | 2 | 93 |
| az containerapp add-on redis | Preview | 2 | 147 |
| az containerapp add-on weaviate | Preview | 2 | 84 |
| az containerapp ssl | GA | 1 | 287 |
NOTE: Azure CLI command az containerapp ssl is a Core command and needs to be fixed in Azure/azure-cli.
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 containerapp add-on kafka create | 4 | yes | 132 |
| az containerapp add-on kafka delete | 4 | 132 | |
| az containerapp add-on list | 2 | 541 | |
| az containerapp add-on mariadb create | 4 | yes | 86 |
| az containerapp add-on mariadb delete | 4 | 86 | |
| az containerapp add-on milvus create | 4 | yes | 54 |
| az containerapp add-on milvus delete | 4 | 54 | |
| az containerapp add-on postgres create | 4 | yes | 207 |
| az containerapp add-on postgres delete | 4 | 207 | |
| az containerapp add-on qdrant create | 4 | yes | 93 |
| az containerapp add-on qdrant delete | 4 | 93 | |
| az containerapp add-on redis create | 4 | yes | 147 |
| az containerapp add-on redis delete | 4 | 147 | |
| az containerapp add-on weaviate create | 4 | yes | 84 |
| az containerapp add-on weaviate delete | 4 | 84 | |
| az containerapp ssl upload | 10 | 287 |
Related command
az containerapp
Errors
n/a
Issue script & Debug output
n/a
Expected behavior
n/a
Environment Summary
Azure CLI 2.63.0
Additional context
No response
Thank you for opening this issue, we will look into it.
Here are some similar issues that might help you. Please check if they can solve your problem.
- Azure/azure-cli-extensions#8066
- Azure/azure-cli-extensions#8103
Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @mksuni, @bgklein, @mscurrell, @dpwatrous, @gingi, @paterasMSFT, @cRui861.
Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @calvinsID.
Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @mksuni, @bgklein, @mscurrell, @dpwatrous, @gingi, @paterasMSFT, @cRui861.
Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @calvinsID.