Skip to content

[App service]: az webapp config set : Add additional help examples for powershell users#19185

Merged
StrawnSC merged 1 commit intoAzure:devfrom
StrawnSC:add-powershell-webapp-config-set-examples
Aug 12, 2021
Merged

[App service]: az webapp config set : Add additional help examples for powershell users#19185
StrawnSC merged 1 commit intoAzure:devfrom
StrawnSC:add-powershell-webapp-config-set-examples

Conversation

@StrawnSC
Copy link
Copy Markdown
Contributor

Description

Adds additional examples to the help text for the command az webapp config set to help PowerShell users properly use the --generic-configurations option. PowerShell apparently requires more strict usage of escape characters than bash, so PowerShell users were having issues when trying to pass in JSON via this command. The new help text clarifies that PowerShell users must escape the double quotes in their JSON with a backslash (or pass in a JSON file name).

Testing Guide

Generate the relevant help text with az webapp config set --help

History Notes

N/A


This checklist is used to make sure that common guidelines for a pull request are followed.

@yonzhan
Copy link
Copy Markdown
Collaborator

yonzhan commented Aug 11, 2021

appservice

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need to make the same updates for functional config set as well.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seligj95 can you review the text & provide the blob you'd like to use here in the help. Thanks!

@panchagnula panchagnula requested a review from seligj95 August 11, 2021 05:14
@panchagnula panchagnula changed the title [appservice] az webapp config set : Add additional help examples for powershell users {app service}: az webapp config set : Add additional help examples for powershell users Aug 11, 2021
@panchagnula panchagnula changed the title {app service}: az webapp config set : Add additional help examples for powershell users [App service]: az webapp config set : Add additional help examples for powershell users Aug 11, 2021
Copy link
Copy Markdown
Contributor

@panchagnula panchagnula left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - but lets wait for text review from PM & incase he wants to update this.

Copy link
Copy Markdown
Contributor

@seligj95 seligj95 Aug 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we add that you have to use the path to the file? it's probably obvious to most people, but just adding the bold below could help.

for PowerShell users, set configuration through a JSON file called params.json which is located in the current working directory

Copy link
Copy Markdown
Contributor

@seligj95 seligj95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left a comment for review

@StrawnSC StrawnSC force-pushed the add-powershell-webapp-config-set-examples branch from 775c066 to dcf3d6b Compare August 11, 2021 18:48
Copy link
Copy Markdown
Contributor

@panchagnula panchagnula left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@StrawnSC StrawnSC merged commit 9515062 into Azure:dev Aug 12, 2021
@StrawnSC StrawnSC deleted the add-powershell-webapp-config-set-examples branch October 27, 2021 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants