az acat | no examples given in reference content

[dbradish-microsoft]

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 with no examples:

Reference name	Parameter count	is Create
az acat onboard	2
az acat quick-evaluation	2
az acat report create	7	yes
az acat report delete	3
az acat report download	6
az acat report get-control-assessments	10
az acat report list	9
az acat report show	1
az acat report snapshot download	6
az acat report snapshot list	10
az acat report update	7
az acat report wait	8
az acat report webhook create	9	yes
az acat report webhook delete	3
az acat report webhook list	10
az acat report webhook show	2
az acat report webhook update	9
az acat trigger-evaluation	2

Related command

az acat

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Azure CLI 2.62.0

Additional context

No response

[yonzhan]

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

[github-actions[bot]]

Here are some similar issues that might help you. Please check if they can solve your problem.

• Azure/azure-cli-extensions#8086

[dbradish-microsoft]

@yonzhan, What needs to be done to get this GitHub issue assigned to a service team member?

[jsntcy]

Add @yanshudan from service team to take a look.

[yanshudan]

Acknowledged. May I know if there is a deadline for this request? @dbradish-microsoft

[dbradish-microsoft]

@yanshudan, the issue is that every new reference command should have at least one example, preferably two at the time of publishing as specified in the Azure CLI reference guidelines. Theoretically then, the deadline was yesterday. However, let's begin again today and continue from here.

As long as App Compliance Automation team can commit to a date before Ignite 2024, we'll be grateful. Does that sound reasonable to you?

[yanshudan]

@dbradish-microsoft Sure, we can commit that the examples can be added before Ignite 2024. Will update in this issue when the examples are merged.