search

Azure / azure-cli

Azure Command-Line Interface
MIT License
3.93k stars 2.9k forks source link

az container app up | In in-line help, provide list of azCLI reference commands being executed #28562

Open dbradish-microsoft opened 4 months ago

dbradish-microsoft commented 4 months ago

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/container/app#az-container-app-up Related reference command link: https://learn.microsoft.com/en-us/cli/azure/containerapp#az-containerapp-up

Current description of "az container app up": Deploy to Azure Container Instances using GitHub Actions. Current description of "az containerapp up": Create or update a container app as well as any associated resources (ACR, resource group, container apps environment, GitHub Actions, etc.).

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

Possible impacted source code files (where this descriptions are found): az container app up

  1. https://github.com/azure/deploy-to-azure-cli-extension/blob/master/deploy-to-azure/azext_deploy_to_azure/dev/aci/_help.py
  2. https://github.com/azure/deploy-to-azure-cli-extension/blob/master/deploy-to-azure/azext_deploy_to_azure/dev/aci/up.py

az containerapp up

  1. https://github.com/azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py
  2. https://github.com/azure/azure-cli-extensions/blob/main/src/containerapp/azext_containerapp/_help.py

Related command

az container app up and az containerapp up

QUESTION: Is this spelling on purpose, or is this something we are fixing?

Errors

n/a

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[bot] commented 4 months ago
Hi @dbradish-microsoft Find similar issue https://github.com/Azure/azure-cli/issues/28560.
Issue title az aks app up Provide list of azCLI reference commands being executed in in-line help
Create time 2024-03-14
Comment number 0

Please confirm if this resolves your issue.

yonzhan commented 4 months ago

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

microsoft-github-policy-service[bot] commented 4 months ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @dkkapur.

dbradish-microsoft commented 2 weeks ago

@dkkapur, 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.