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 storage | missing examples in reference content #29652

Open
dbradish-microsoft opened this issue Aug 5, 2024 · 2 comments
Open

az storage | missing examples in reference content #29652

dbradish-microsoft opened this issue Aug 5, 2024 · 2 comments
Assignees
Labels
Auto-Assign Auto assign by bot Azure CLI Team The command of the issue is owned by Azure CLI team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Storage az storage

Comments

@dbradish-microsoft
Copy link
Contributor

dbradish-microsoft commented Aug 5, 2024

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

Reference subgroups with no examples:

Note: The commands for these subgroups are in the second table (below).

Group name Reference count Status Prior 6 month PVs
az storage account task-assignment 7 GA
az storage azcopy 1 GA 4653
az storage blob tag 2 Preview 1222
az storage container immutability-policy 5 GA 5935
az storage container metadata 2 GA 844
az storage container policy 5 GA 1776
az storage directory metadata 2 GA 410
az storage queue policy 5 Preview 715
az storage share metadata 2 GA 358
az storage share policy 5 GA 1265
az storage table 6 GA 809
az storage table policy 5 GA 980

Reference commands with no examples:

Note: Some of these command subgroups have at least one example. This table is a list of all az storage commands with no example.

Reference name Parameter count is Create
az storage account check-name 1
az storage account management-policy delete 2
az storage account management-policy show 2
az storage account task-assignment create 9 yes
az storage account task-assignment delete 7
az storage account task-assignment list 5
az storage account task-assignment list-report 7
az storage account task-assignment show 5
az storage account task-assignment update 15
az storage account task-assignment wait 12
az storage azcopy run-command 1
az storage blob copy cancel 11
az storage blob filter 8
az storage blob incremental-copy cancel 10
az storage blob lease break 14
az storage blob lease change 16
az storage blob lease release 17
az storage blob service-properties show 6
az storage blob snapshot 17
az storage blob tag list 13
az storage blob tag set 13
az storage blob update 22
az storage container immutability-policy create 7 yes
az storage container immutability-policy delete 4
az storage container immutability-policy extend 7
az storage container immutability-policy lock 4
az storage container immutability-policy show 4
az storage container metadata show 9
az storage container metadata update 12
az storage container policy create 11 yes
az storage container policy delete 8
az storage container policy list 7
az storage container policy show 8
az storage container policy update 11
az storage container set-permission 11
az storage container show 9
az storage container show-permission 8
az storage cors add 11 yes
az storage directory create 14 yes
az storage directory delete 13
az storage directory metadata show 12
az storage directory metadata update 13
az storage directory show 12
az storage entity delete 10
az storage entity merge 9
az storage entity replace 9
az storage entity show 10
az storage file copy cancel 12
az storage file delete 11
az storage file download 19
az storage file resize 9
az storage fs directory metadata update 10
az storage fs file metadata update 10
az storage fs file set-expiry 11
az storage fs metadata update 9
az storage logging update 9
az storage queue policy create 10 yes
az storage queue policy delete 7
az storage queue policy list 6
az storage queue policy show 7
az storage queue policy update 10
az storage share delete 12
az storage share list 11
az storage share metadata show 8
az storage share metadata update 8
az storage share policy create 10 yes
az storage share policy delete 7
az storage share policy list 6
az storage share policy show 7
az storage share policy update 10
az storage share show 8
az storage share snapshot 9
az storage share stats 7
az storage share update 8
az storage table create 8 yes
az storage table delete 8
az storage table exists 7
az storage table generate-sas 16
az storage table list 9
az storage table policy create 10 yes
az storage table policy delete 7
az storage table policy list 6
az storage table policy show 7
az storage table policy update 10
az storage table stats 6

Related command

az storage

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Azure CLI 2.62.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 5, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the Auto-Assign Auto assign by bot label Aug 5, 2024
@yonzhan
Copy link
Collaborator

yonzhan commented Aug 5, 2024

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

@microsoft-github-policy-service microsoft-github-policy-service bot added Azure CLI Team The command of the issue is owned by Azure CLI team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Aug 5, 2024
@yonzhan yonzhan added this to the Backlog milestone Aug 5, 2024
@yonzhan yonzhan removed the bug This issue requires a change to an existing behavior in the product in order to be resolved. label Aug 5, 2024
@calvinhzy
Copy link
Member

@dbradish-microsoft, must have been missed, will include in the next release. Thanks.

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 Azure CLI Team The command of the issue is owned by Azure CLI team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Storage az storage
Projects
None yet
Development

No branches or pull requests

5 participants