az boards | missing examples in reference content

[dbradish-microsoft]

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 boards	GA	1	4954
az boards area project	GA	5	603
az boards iteration project	GA	5	1095
az boards iteration team	GA	8	836
az boards work-item	GA	4	6495
az boards work-item relation	GA	4	1776

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 boards area project create	5	yes	603
az boards area project delete	5		603
az boards area project list	5		603
az boards area project show	4		603
az boards area project update	6		603
az boards area team list	4		368
az boards area team remove	5		368
az boards area team update	7		368
az boards iteration project create	7	yes	1095
az boards iteration project delete	5		1095
az boards iteration project list	5		1095
az boards iteration project show	4		1095
az boards iteration project update	8		1095
az boards iteration team add	5	yes	836
az boards iteration team list	5		836
az boards iteration team list-work-items	5		836
az boards iteration team remove	5		836
az boards iteration team set-backlog-iteration	5		836
az boards iteration team set-default-iteration	6		836
az boards iteration team show-backlog-iteration	4		836
az boards iteration team show-default-iteration	4		836
az boards query	6		4954
az boards work-item create	13	yes	6495
az boards work-item delete	6		6495
az boards work-item relation add	6	yes	1776
az boards work-item relation list-type	2		1776
az boards work-item relation remove	6		1776
az boards work-item relation show	3		1776
az boards work-item show	7		6495
az boards work-item update	13		6495

Related command

az boards

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]

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

[microsoft-github-policy-service]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @mksuni, @bgklein, @mscurrell, @dpwatrous, @gingi, @paterasMSFT, @cRui861.