Azure / Azure/azure-cli-extensions

az adp | missing examples in reference content

Open
#8,059 1 comment 0 reactions 0 assignees View on GitHub
bug Service Attention
Dominant language
Python
Stars
454
Forks
1.7k
Avg merge
2d 19h
Merged PRs (30d)
64

Description

### Describe the bug

### 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 ...).

### 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](https://docs.microsoft.com/cli/azure/adp/account) | GA | 6 | 35 |
| [az adp account data-pool](https://docs.microsoft.com/cli/azure/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](https://docs.microsoft.com/cli/azure/adp/account#az-adp-account-create) | 5 | **yes** | 35 |
| [az adp account data-pool create](https://docs.microsoft.com/cli/azure/adp/account/data-pool#az-adp-account-data-pool-create) | 6 | **yes** | 8 |
| [az adp account data-pool delete](https://docs.microsoft.com/cli/azure/adp/account/data-pool#az-adp-account-data-pool-delete) | 7 | | 8 |
| [az adp account data-pool list](https://docs.microsoft.com/cli/azure/adp/account/data-pool#az-adp-account-data-pool-list) | 2 | | 8 |
| [az adp account data-pool show](https://docs.microsoft.com/cli/azure/adp/account/data-pool#az-adp-account-data-pool-show) | 5 | | 8 |
| [az adp account data-pool update](https://docs.microsoft.com/cli/azure/adp/account/data-pool#az-adp-account-data-pool-update) | 12 | | 8 |
| [az adp account data-pool wait](https://docs.microsoft.com/cli/azure/adp/account/data-pool#az-adp-account-data-pool-wait) | 12 | | 8 |
| [az adp account delete](https://docs.microsoft.com/cli/azure/adp/account#az-adp-account-delete) | 6 | | 35 |
| [az adp account list](https://docs.microsoft.com/cli/azure/adp/account#az-adp-account-list) | 1 | | 35 |
| [az adp account show](https://docs.microsoft.com/cli/azure/adp/account#az-adp-account-show) | 4 | | 35 |
| [az adp account update](https://docs.microsoft.com/cli/azure/adp/account#az-adp-account-update) | 10 | | 35 |
| [az adp account wait](https://docs.microsoft.com/cli/azure/adp/account#az-adp-account-wait) | 11 | | 35 |
| [az adp workspace wait](https://docs.microsoft.com/cli/azure/adp/workspace#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_

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.