search

Azure / azure-cli

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

Customer feedback | az aks command result | Optional parameter is required! #30107

Open dbradish-microsoft opened 1 month ago

dbradish-microsoft commented 1 month ago

Describe the bug

This GitHub issue is being moved from MicrosoftDocs/azure-docs-cli 4687 for AKS team response, and to raise awareness to this recurring customer feedback.

Engineer request

  1. The --command-id appears to be required. Please verify that this parameter has been flagged correctly.
  2. If the --command-id is optional, could it actually be conditional? Example, "if you supply {a} then you also must apply {b}" or similar logic? If so, please add more information in the short-summary parameter description to make this clear to our customers.

Customer feedback

Type of issue Outdated article

Feedback The title is self explanatory I think. When I run the command "az aks command result" without the parameter "--command-id -i", it complains that the parameter is missing. It makes sense, but the documentation still says it's Optional.

Updating the documentation would be nice. Thanks

Page URL https://learn.microsoft.com/en-us/cli/azure/aks/command?view=azure-cli-latest#az-aks-command-result

Content source URL https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/aks/command.yml

Related command

az aks command result

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Azure CLI 2.65.0

Additional context

No response

yonzhan commented 1 month ago

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

yonzhan commented 1 month ago

@FumingZhang for awareness

FumingZhang commented 1 month ago

@haitch could you please help take a look?