az webapp config appsettings

  • Reference

Configure web app settings. Updating or removing application settings will cause an app recycle.

Commands

Name Description Type Status
az webapp config appsettings delete

Delete web app settings.

 Core GA
az webapp config appsettings list

Get the details of a web app's settings.

 Core GA
az webapp config appsettings set

Set a web app's settings.

 Core GA

az webapp config appsettings delete

Delete web app settings.

Note that setting values are now redacted in the result. Please use the az webapp config appsettings list command to view the settings.

az webapp config appsettings delete --setting-names
                                    [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--slot]
                                    [--subscription]

Examples

Delete web app settings. (autogenerated)

az webapp config appsettings delete --name MyWebApp --resource-group MyResourceGroup --setting-names {setting-names}

Required Parameters

--setting-names

Space-separated appsettings names.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--slot -s

The name of the slot. Default to the productions slot if not specified.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az webapp config appsettings list

Get the details of a web app's settings.

az webapp config appsettings list --name
                                  --resource-group
                                  [--slot]

Examples

Get the details of a web app's settings. (autogenerated)

az webapp config appsettings list --name MyWebapp --resource-group MyResourceGroup --subscription MySubscription

Required Parameters

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az webapp config appsettings set

Set a web app's settings.

Note that setting values are now redacted in the result. Please use the az webapp config appsettings list command to view the settings.

az webapp config appsettings set [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--settings]
                                 [--slot]
                                 [--slot-settings]
                                 [--subscription]

Examples

Set the default NodeJS version to 6.9.1 for a web app.

az webapp config appsettings set -g MyResourceGroup -n MyUniqueApp --settings WEBSITE_NODE_DEFAULT_VERSION=6.9.1

Set using both key-value pair and a json file with more settings.

az webapp config appsettings set -g MyResourceGroup -n MyUniqueApp --settings mySetting=value @moreSettings.json

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--settings

Space-separated appsettings in KEY=VALUE format. Use @{file} to load from a file. See https://go.microsoft.com/fwlink/?linkid=2219923 for more information on file format and editing app settings in bulk.

--slot -s

The name of the slot. Default to the productions slot if not specified.

--slot-settings

Space-separated appsettings in KEY=VALUE format. Use @{file} to load from a file. Given setting are added to the configuration and marked as Deployment slot setting by default.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.