Azure / Azure/azure-cli

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

Open
#30,014 2 comments 0 reactions 2 assignees Claimed by @calvinhzy View on GitHub
act-codegen-extensibility-squad Auto-Assign Azure CLI Team question Similar-Issue Storage
Dominant language
Python
Stars
4.6k
Forks
3.5k
Avg merge
3d 2h
Merged PRs (30d)
60

Description

### Describe the bug

This GitHub issue is being moved from UUF azDO work item [316997](https://dev.azure.com/msft-skilling/Content/_workitems/edit/316997/).

### Engineering request

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

According to the [Azure CLI reference guidelines](https://github.com/Azure/azure-cli/blob/dev/doc/reference_doc_guidelines.md#examples), 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_

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.