Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

az communication | missing examples in reference content #8073

Open
dbradish-microsoft opened this issue Aug 6, 2024 · 4 comments
Open

az communication | missing examples in reference content #8073

dbradish-microsoft opened this issue Aug 6, 2024 · 4 comments
Labels
Auto-Assign Auto assign by bot bug This issue requires a change to an existing behavior in the product in order to be resolved. Communication Label for AzureCommunicationServices Service Attention This issue is responsible by Azure service team. Similar-Issue

Comments

@dbradish-microsoft
Copy link
Contributor

dbradish-microsoft commented Aug 6, 2024

Describe the bug

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 without examples:

Reference name Parameter count is Create
az communication create 9 yes
az communication delete 6
az communication email domain wait 12
az communication email wait 11
az communication identity assign 5
az communication identity remove 5
az communication identity show 2
az communication identity wait 11
az communication link-notification-hub 6
az communication list 1
az communication list-key 4
az communication regenerate-key 5
az communication show 4
az communication update 13
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

@dbradish-microsoft dbradish-microsoft added the bug This issue requires a change to an existing behavior in the product in order to be resolved. label Aug 6, 2024
@yonzhan
Copy link
Collaborator

yonzhan commented Aug 6, 2024

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

@yonzhan yonzhan added Communication Label for AzureCommunicationServices Service Attention This issue is responsible by Azure service team. labels Aug 6, 2024
Copy link
Contributor

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @acsdevx-msft.

@dbradish-microsoft dbradish-microsoft changed the title az communication | no examples given in reference content az communication | missing examples given in reference content Aug 7, 2024
Copy link

github-actions bot commented Aug 7, 2024

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

Copy link
Contributor

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @acsdevx-msft.

@dbradish-microsoft dbradish-microsoft changed the title az communication | missing examples given in reference content az communication | missing examples in reference content Aug 7, 2024
@dbradish-microsoft dbradish-microsoft transferred this issue from Azure/azure-cli Oct 7, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the Auto-Assign Auto assign by bot label Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Assign Auto assign by bot bug This issue requires a change to an existing behavior in the product in order to be resolved. Communication Label for AzureCommunicationServices Service Attention This issue is responsible by Azure service team. Similar-Issue
Projects
None yet
Development

No branches or pull requests

2 participants