[App Service] Docs and help text improvements for deploy, connection-string, and SSL commands#33051
Open
[App Service] Docs and help text improvements for deploy, connection-string, and SSL commands#33051
Conversation
seligj95
requested review from
NoriZC,
teresaritorto and
yanzhudd
as code owners
️✔️AzureCLI-FullTest
|
|
Hi @seligj95, |
️✔️AzureCLI-BreakingChangeTest
|
microsoft-github-policy-service
bot
requested review from
jsntcy,
wangzelin007,
yonzhan and
zhoxing-ms
microsoft-github-policy-service
bot
added
Web Apps
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
Contributor
There was a problem hiding this comment.
Pull request overview
Improves az webapp deploy help text and parameter documentation to clarify defaults, applicability, and add more usage examples.
Changes:
- Clarified
--timeout,--acr-use-identity, and--track-statushelp text (defaults, behavior, and interactions). - Added a
long-summarydescribing parameter compatibility and limitations. - Expanded help examples from 2 to 6 covering common deployment scenarios.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
src/azure-cli/azure/cli/command_modules/appservice/_params.py |
Updates parameter help strings for clarity on defaults/behavior for deploy and ACR identity options. |
src/azure-cli/azure/cli/command_modules/appservice/_help.py |
Adds long-summary compatibility notes and expands az webapp deploy examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
seligj95
changed the title
az webapp deploy: Improve parameter documentation and examples
…#29759, Azure#29758, Azure#29561, Azure#30110) - Add default timeout value to --timeout help text - Clarify --acr-use-identity default behavior - Document --track-status behavior and parameter relationships - Add more examples to az webapp deploy help (URL deploy, slots, --clean) Fixes Azure#29759 Fixes Azure#29758 Fixes Azure#29561 Fixes Azure#30110 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
seligj95
force-pushed
the
fix/webapp-deploy-help-text
branch
from
988a792 to
09c297f
Compare
Document the App Service environment variable prefixes for each connection string type (SQLAZURECONNSTR_, POSTGRESQLCONNSTR_, etc.) and note that .NET GetConnectionString() only auto-maps SQL/Custom prefixes. Users with PostgreSQL/MySQL must read the env var directly. Updates _help.py long-summary and adds PostgreSQL example. Updates _params.py --connection-string-type help text. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
seligj95
changed the title
az webapp deploy: Improve parameter documentation and examples…ux-fx-version help text and examples - Add --scope example to webapp create help showing managed identity assignment - Update --linux-fx-version help with RUNTIME|VERSION format and current runtime examples - Add --linux-fx-version examples to webapp config set help for Python, Node, .NET Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
seligj95
changed the title
seligj95
changed the title
…g linter rule The CLI linter flags bare <name> as a disallowed HTML tag in help text. Wrapping SQLCONNSTR_<name> and similar patterns in backticks fixes the disallowed_html_tag_from_command HIGH severity violation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Consolidated PR
This PR consolidates docs and help text improvements from two separate PRs into one.
Changes
Deploy docs + connection-string docs (originally PR #33051)
--acr-use-identityparameter being enabled or disabled vs true or false #29759: Improveaz webapp deployparameter documentation--track-status#29758: Improveaz webapp deployparameter documentationaz webapp deployparameter documentation--timeoutparameter should have a default value #30110: Improveaz webapp deployparameter documentationHelp text improvements (originally PR #33065)
--scopeparameter #30336: Improve--scopehelp text and examples--linux-fx-versionparameter needs more explanation #29761: Improve--linux-fx-versionhelp text and examplesTesting
azdev style appservice— PASSED