Azure / Azure/azure-cli-extensions

az communication | missing examples in reference content

Open
#8,073 5 comments 0 reactions 0 assignees View on GitHub
Auto-Assign bug Communication Service Attention Similar-Issue
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 ...).

### Command list without examples:

| Reference name | Parameter count | is Create |
|-|-|-|
| [az communication create](https://docs.microsoft.com/cli/azure/communication#az-communication-create) | 9 | **yes** |
| [az communication delete](https://docs.microsoft.com/cli/azure/communication#az-communication-delete) | 6 | |
| [az communication email domain wait](https://docs.microsoft.com/cli/azure/communication/email/domain#az-communication-email-domain-wait) | 12 | |
| [az communication email wait](https://docs.microsoft.com/cli/azure/communication/email#az-communication-email-wait) | 11 | |
| [az communication identity assign](https://docs.microsoft.com/cli/azure/communication/identity#az-communication-identity-assign) | 5 | |
| [az communication identity remove](https://docs.microsoft.com/cli/azure/communication/identity#az-communication-identity-remove) | 5 | |
| [az communication identity show](https://docs.microsoft.com/cli/azure/communication/identity#az-communication-identity-show) | 2 | |
| [az communication identity wait](https://docs.microsoft.com/cli/azure/communication/identity#az-communication-identity-wait) | 11 | |
| [az communication link-notification-hub](https://docs.microsoft.com/cli/azure/communication#az-communication-link-notification-hub) | 6 | |
| [az communication list](https://docs.microsoft.com/cli/azure/communication#az-communication-list) | 1 | |
| [az communication list-key](https://docs.microsoft.com/cli/azure/communication#az-communication-list-key) | 4 | |
| [az communication regenerate-key](https://docs.microsoft.com/cli/azure/communication#az-communication-regenerate-key) | 5 | |
| [az communication show](https://docs.microsoft.com/cli/azure/communication#az-communication-show) | 4 | |
| [az communication update](https://docs.microsoft.com/cli/azure/communication#az-communication-update) | 13 | |
| [az communication wait](https://docs.microsoft.com/cli/azure/communication#az-communication-wait) | 11 | |

### Related command

az communication

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