Share via

az staticwebapp appsettings

  • Reference

Manage app settings the static app.

Commands

Name Description Type Status
az staticwebapp appsettings delete

Delete app settings with given keys of the static app.

 Core GA
az staticwebapp appsettings list

List app settings of the static app.

 Core GA
az staticwebapp appsettings set

Add to or change the app settings of the static app.

 Core GA

az staticwebapp appsettings delete

Delete app settings with given keys of the static app.

az staticwebapp appsettings delete --name
                                   --setting-names
                                   [--environment-name]
                                   [--resource-group]

Examples

Delete given app settings of the static app.

az staticwebapp appsettings delete -n MyStaticAppName --setting-names key1 key2

Delete given app settings of the static app.

az staticwebapp appsettings delete -n MyStaticAppName --setting-names key1 key2 --environment-name MyEnvironmentName

Required Parameters

--name -n

Name of the static site.

--setting-names

Space-separated app setting names.

Optional Parameters

--environment-name

Name of the environment of static site.

--resource-group -g

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

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 staticwebapp appsettings list

List app settings of the static app.

az staticwebapp appsettings list --name
                                 [--environment-name]
                                 [--resource-group]

Examples

List app settings of the static app.

az staticwebapp appsettings list -n MyStaticAppName

List app settings of the static app environment.

az staticwebapp appsettings list -n MyStaticAppName --environment-name MyEnvironmentName

Required Parameters

--name -n

Name of the static site.

Optional Parameters

--environment-name

Name of the environment of static site.

--resource-group -g

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

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 staticwebapp appsettings set

Add to or change the app settings of the static app.

az staticwebapp appsettings set --name
                                --setting-names
                                [--environment-name]
                                [--resource-group]

Examples

Add to or change the app settings of the static app.

az staticwebapp appsettings set -n MyStaticAppName --setting-names key1=val1 key2=val2

Add to or change the app settings of the static app environment.

az staticwebapp appsettings set -n MyStaticAppName --setting-names key1=val1 key2=val2 --environment-name MyEnvironmentName

Required Parameters

--name -n

Name of the static site.

--setting-names

Space-separated app settings in 'key=value' format.

Optional Parameters

--environment-name

Name of the environment of static site.

--resource-group -g

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

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.