Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

az adp | missing examples in reference content #8059

Open
dbradish-microsoft opened this issue Aug 8, 2024 · 1 comment
Open

az adp | missing examples in reference content #8059

dbradish-microsoft opened this issue Aug 8, 2024 · 1 comment
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Service Attention This issue is responsible by Azure service team.

Comments

@dbradish-microsoft
Copy link
Contributor

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 adp account GA 6 35
az adp account data-pool GA 6 8

Reference commands with no examples:

Note: Some of these command subgroups have at least one example. This table is a list of all az adp commands with no examples. 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 adp account create 5 yes 35
az adp account data-pool create 6 yes 8
az adp account data-pool delete 7 8
az adp account data-pool list 2 8
az adp account data-pool show 5 8
az adp account data-pool update 12 8
az adp account data-pool wait 12 8
az adp account delete 6 35
az adp account list 1 35
az adp account show 4 35
az adp account update 10 35
az adp account wait 11 35
az adp workspace wait 11 32

Related command

az adp

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Azure CLI 2.63.0

Additional context

No response

@dbradish-microsoft dbradish-microsoft added the bug This issue requires a change to an existing behavior in the product in order to be resolved. label Aug 8, 2024
@yonzhan
Copy link
Collaborator

yonzhan commented Aug 8, 2024

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

@yonzhan yonzhan added the Service Attention This issue is responsible by Azure service team. label Aug 8, 2024
@dbradish-microsoft dbradish-microsoft transferred this issue from Azure/azure-cli Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Service Attention This issue is responsible by Azure service team.
Projects
None yet
Development

No branches or pull requests

2 participants