Azure / azure-cli

Azure Command-Line Interface
MIT License
4.03k stars 3k forks source link

Customer feedback | az storage entity | missing examples | azDO #316997 #30014

Open dbradish-microsoft opened 1 month ago

dbradish-microsoft commented 1 month ago

Describe the bug

This GitHub issue is being moved from UUF azDO work item 316997.

Engineering request

Add one example for each parameter in the az storage entity command subgroup.

According to the Azure CLI reference guidelines, there needs to be one example for every parameter. The purpose for this requirement is to avoid customer fustration like the one articulated below.

Customer feedback

Title: az storage entity | Microsoft Learn

Verbatim: The optional parameter of filter for az storage entity query needs to have an example e.g. "PartitionKey eq '1f25b08ff8b943f49abc7c120d46e2a4".Same for filter e.g. "Name,EventType,Result"

Verbatim Id: 88c33978-1d7a-ef11-a670-6045bd022a79

Live URL: https://learn.microsoft.com/en-us/cli/azure/storage/entity

GitHub URL: https://github.com/MicrosoftDocs/azure-docs-cli/blob/live/2020-09-01-hybrid/docs-ref-autogen/storage/entity.yml

Related command

az storage entity query

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

One example for every parameter.

Environment Summary

Azure CLI 2.64.0

Additional context

No response

yonzhan commented 1 month ago

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

github-actions[bot] commented 1 month ago

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