Azure / Azure/azure-cli

Improve the Azure CLI doc

Open
#28,102 4 comments 0 reactions 2 assignees Claimed by @jiasli View on GitHub
Azure CLI Team customer-reported Docs feature-request
Dominant language
Python
Stars
4.6k
Forks
3.5k
Avg merge
3d 2h
Merged PRs (30d)
60

Description

### Describe the bug

For this parameter "--name" in this page https://learn.microsoft.com/en-us/cli/azure/cloud?view=azure-cli-latest#az-cloud-set, why don't you list the available options for this parameter? I found this is the case in many of your doc that you don't list the options of a parameter, think in your customer's shoes, when I come to the official doc, I would like to see all details in one place rather than do another google search how to use this paramter!

### Related command

For this parameter "--name" in this page https://learn.microsoft.com/en-us/cli/azure/cloud?view=azure-cli-latest#az-cloud-set, why don't you list the available options for this parameter?

### Errors

For this parameter "--name" in this page https://learn.microsoft.com/en-us/cli/azure/cloud?view=azure-cli-latest#az-cloud-set, why don't you list the available options for this parameter? I found this is the case in many of your doc that you don't list the options of a parameter, think in your customer's shoes, when I come to the official doc, I would like to see all details in one place rather than do another google search how to use this paramter!

### Issue script & Debug output

For this parameter "--name" in this page https://learn.microsoft.com/en-us/cli/azure/cloud?view=azure-cli-latest#az-cloud-set, why don't you list the available options for this parameter? I found this is the case in many of your doc that you don't list the options of a parameter, think in your customer's shoes, when I come to the official doc, I would like to see all details in one place rather than do another google search how to use this paramter!

### Expected behavior

For this parameter "--name" in this page https://learn.microsoft.com/en-us/cli/azure/cloud?view=azure-cli-latest#az-cloud-set, why don't you list the available options for this parameter? I found this is the case in many of your doc that you don't list the options of a parameter, think in your customer's shoes, when I come to the official doc, I would like to see all details in one place rather than do another google search how to use this paramter!

### Environment Summary

For this parameter "--name" in this page https://learn.microsoft.com/en-us/cli/azure/cloud?view=azure-cli-latest#az-cloud-set, why don't you list the available options for this parameter? I found this is the case in many of your doc that you don't list the options of a parameter, think in your customer's shoes, when I come to the official doc, I would like to see all details in one place rather than do another google search how to use this paramter!

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