az aks draft up | In in-line help, provide list of azCLI reference commands being executed

[dbradish-microsoft]

Describe the bug

Customers are asking what Azure CLI reference commands are being executed by our az ... up commands. Doc writers are also requesting this information when they must replicate Azure CLI docs with Azure PowerShell commands. Although the reference list might change based on the parameters being passed, we need clarity in our in-line help and resulting autogenerated reference content.

Reference command link: https://learn.microsoft.com/en-us/cli/azure/aks/draftt#az-aks-draft-up

Current description:
(This description is actually more helpful than some of the other up descriptions, but it needs to tell customers all of the azCLI commands being executed.)

REQUEST: Please modify this description to list each Azure CLI reference command that "up" can/is executing.

Possible impacted source code files:
https://github.com/azure/azure-cli-extensions/blob/main/src/aks-preview/azext_aks_preview/_help.py

Related command

az aks draft up

Errors

This bug is being entered to eliminate customer confusion by adding clarity to our help content.

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Azure CLI 2.58.0

Additional context

No response

[azure-client-tools-bot-prd]

Hi @dbradish-microsoft
Find similar issue #8060.

Issue title	az aks app up
Create time	2024-03-14
Comment number	0

---

Please confirm if this resolves your issue.

[yonzhan]

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

[microsoft-github-policy-service]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @dyu1208, @FumingZhang, @andyliuliming.

[dbradish-microsoft]

@dyu1208, @FumingZhang, @andyliuliming.

Can we resolve this issue by putting a sentence in the short or long summary that states something like "Run this command with the --debug parameter to see the API calls and parameters values being used."?

This avoids a lengthy long-summary property, but tells the customer how to find the answer for themselves.

[FumingZhang]

@karenychen to help

From my understanding, this command basically does not call ARM, but executes the draft program/binary.

[karenychen]

Hi @dbradish-microsoft, aks draft up only runs the setup-gh and the generate-workflow command. I have updated the short summary to include them. Please let me know if this fix looks good, thanks!

[dbradish-microsoft]

@karenychen, do you have a link to your PR that reflects the update?

[karenychen]

HI @dbradish-microsoft, PR link is mentioned in this thread. PR link: #7782

[dbradish-microsoft]

@karenychen, thank you.