Azure / Azure/azure-cli-extensions
az acat | no examples given in reference content
- Dominant language
- Python
- Stars
- 454
- Forks
- 1.7k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 64
Description
### Bug category:
**Missing information**
### Request:
The [Azure CLI reference guidelines](https://github.com/Azure/azure-cli/blob/dev/doc/reference_doc_guidelines.md#examples) specifiy at least two examples for each command. Please review the Azure CLI reference guidelines for [examples](https://github.com/Azure/azure-cli/blob/dev/doc/reference_doc_guidelines.md#examples) and [parameters](https://github.com/Azure/azure-cli/blob/dev/doc/reference_doc_guidelines.md#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](https://docs.microsoft.com/cli/azure/acat#az-acat-onboard) | 2 | |
| [az acat quick-evaluation](https://docs.microsoft.com/cli/azure/acat#az-acat-quick-evaluation) | 2 | |
| [az acat report create](https://docs.microsoft.com/cli/azure/acat/report#az-acat-report-create) | 7 | **yes** |
| [az acat report delete](https://docs.microsoft.com/cli/azure/acat/report#az-acat-report-delete) | 3 | |
| [az acat report download](https://docs.microsoft.com/cli/azure/acat/report#az-acat-report-download) | 6 | |
| [az acat report get-control-assessments](https://docs.microsoft.com/cli/azure/acat/report#az-acat-report-get-control-assessments) | 10 | |
| [az acat report list](https://docs.microsoft.com/cli/azure/acat/report#az-acat-report-list) | 9 | |
| [az acat report show](https://docs.microsoft.com/cli/azure/acat/report#az-acat-report-show) | 1 | |
| [az acat report snapshot download](https://docs.microsoft.com/cli/azure/acat/report/snapshot#az-acat-report-snapshot-download) | 6 | |
| [az acat report snapshot list](https://docs.microsoft.com/cli/azure/acat/report/snapshot#az-acat-report-snapshot-list) | 10 | |
| [az acat report update](https://docs.microsoft.com/cli/azure/acat/report#az-acat-report-update) | 7 | |
| [az acat report wait](https://docs.microsoft.com/cli/azure/acat/report#az-acat-report-wait) | 8 | |
| [az acat report webhook create](https://docs.microsoft.com/cli/azure/acat/report/webhook#az-acat-report-webhook-create) | 9 | **yes** |
| [az acat report webhook delete](https://docs.microsoft.com/cli/azure/acat/report/webhook#az-acat-report-webhook-delete) | 3 | |
| [az acat report webhook list](https://docs.microsoft.com/cli/azure/acat/report/webhook#az-acat-report-webhook-list) | 10 | |
| [az acat report webhook show](https://docs.microsoft.com/cli/azure/acat/report/webhook#az-acat-report-webhook-show) | 2 | |
| [az acat report webhook update](https://docs.microsoft.com/cli/azure/acat/report/webhook#az-acat-report-webhook-update) | 9 | |
| [az acat trigger-evaluation](https://docs.microsoft.com/cli/azure/acat#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_
Contributor guide
Assessment
This issue has not been assessed yet.