Azure / Azure/azure-cli-extensions

az devcenter admin project-catalog | missing examples in reference content

Open
#8,086 2 comments 0 reactions 0 assignees View on GitHub
bug Service Attention Similar-Issue
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:

Note: The `az devcenter admin project-catalog` subgroup has nine reference commands and no examples. All other subgroups have at least one example already.

| Reference name | Parameter count | is Create |
|-|-|-|
| [az devcenter admin attached-network wait](https://docs.microsoft.com/cli/azure/devcenter/admin/attached-network#az-devcenter-admin-attached-network-wait) | 12 | |
| [az devcenter admin catalog wait](https://docs.microsoft.com/cli/azure/devcenter/admin/catalog#az-devcenter-admin-catalog-wait) | 12 | |
| [az devcenter admin devbox-definition update](https://docs.microsoft.com/cli/azure/devcenter/admin/devbox-definition#az-devcenter-admin-devbox-definition-update) | 15 | |
| [az devcenter admin devbox-definition wait](https://docs.microsoft.com/cli/azure/devcenter/admin/devbox-definition#az-devcenter-admin-devbox-definition-wait) | 12 | |
| [az devcenter admin devcenter wait](https://docs.microsoft.com/cli/azure/devcenter/admin/devcenter#az-devcenter-admin-devcenter-wait) | 11 | |
| [az devcenter admin gallery wait](https://docs.microsoft.com/cli/azure/devcenter/admin/gallery#az-devcenter-admin-gallery-wait) | 12 | |
| [az devcenter admin network-connection wait](https://docs.microsoft.com/cli/azure/devcenter/admin/network-connection#az-devcenter-admin-network-connection-wait) | 11 | |
| [az devcenter admin plan wait](https://docs.microsoft.com/cli/azure/devcenter/admin/plan#az-devcenter-admin-plan-wait) | 11 | |
| [az devcenter admin pool wait](https://docs.microsoft.com/cli/azure/devcenter/admin/pool#az-devcenter-admin-pool-wait) | 12 | |
| [az devcenter admin project wait](https://docs.microsoft.com/cli/azure/devcenter/admin/project#az-devcenter-admin-project-wait) | 11 | |
| [az devcenter admin project-catalog connect](https://docs.microsoft.com/cli/azure/devcenter/admin/project-catalog#az-devcenter-admin-project-catalog-connect) | 6 | |
| [az devcenter admin project-catalog create](https://docs.microsoft.com/cli/azure/devcenter/admin/project-catalog#az-devcenter-admin-project-catalog-create) | 8 | **yes** |
| [az devcenter admin project-catalog delete](https://docs.microsoft.com/cli/azure/devcenter/admin/project-catalog#az-devcenter-admin-project-catalog-delete) | 7 | |
| [az devcenter admin project-catalog get-sync-error-detail](https://docs.microsoft.com/cli/azure/devcenter/admin/project-catalog#az-devcenter-admin-project-catalog-get-sync-error-detail) | 5 | |
| [az devcenter admin project-catalog list](https://docs.microsoft.com/cli/azure/devcenter/admin/project-catalog#az-devcenter-admin-project-catalog-list) | 4 | |
| [az devcenter admin project-catalog show](https://docs.microsoft.com/cli/azure/devcenter/admin/project-catalog#az-devcenter-admin-project-catalog-show) | 5 | |
| [az devcenter admin project-catalog sync](https://docs.microsoft.com/cli/azure/devcenter/admin/project-catalog#az-devcenter-admin-project-catalog-sync) | 6 | |
| [az devcenter admin project-catalog update](https://docs.microsoft.com/cli/azure/devcenter/admin/project-catalog#az-devcenter-admin-project-catalog-update) | 14 | |
| [az devcenter admin project-catalog wait](https://docs.microsoft.com/cli/azure/devcenter/admin/project-catalog#az-devcenter-admin-project-catalog-wait) | 12 | |
| [az devcenter admin schedule wait](https://docs.microsoft.com/cli/azure/devcenter/admin/schedule#az-devcenter-admin-schedule-wait) | 12 | |

### Related command

az devcenter

### Errors

n/a

### Issue script & Debug output

n/a

### Expected behavior

n/a

### Environment Summary

Azure CLI 2.63.0

### Additional context

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.