Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az functionapp config appsettings

Configure function app settings.

Commands

Name Description Type Status
az functionapp config appsettings delete

Delete a function app's settings.

 Core GA
az functionapp config appsettings list

Show settings for a function app.

 Core GA
az functionapp config appsettings set

Update a function app's settings.

 Core GA

az functionapp config appsettings delete

Delete a function app's settings.

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

az functionapp config appsettings delete --setting-names
 [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name]
 [--resource-group]
 [--slot]
 [--subscription]

Examples

Delete a function app's settings. (autogenerated)

az functionapp config appsettings delete --name MyFunctionApp --resource-group MyResourceGroup --setting-names {setting-names}

Required Parameters

--setting-names

Space-separated app setting names.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the function app.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments

az functionapp config appsettings list

Show settings for a function app.

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

Examples

Show settings for a function app. (autogenerated)

az functionapp config appsettings list --name MyWebapp --resource-group MyResourceGroup

Required Parameters

--name -n

Name of the function app.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--slot -s

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

az functionapp config appsettings set

Update a function app's settings.

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

az functionapp config appsettings set [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name]
 [--resource-group]
 [--settings]
 [--slot]
 [--slot-settings]
 [--subscription]

Examples

Update a function app's settings.

az functionapp config appsettings set --name MyFunctionApp --resource-group MyResourceGroup --settings foo=bar AzureWebJobsStorage=$storageConnectionString

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the function app.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--settings

Space-separated appsettings in KEY=VALUE format. Use @{file} to load from a file.

--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.

Property Value
Parameter group: Resource Id Arguments

Feedback

Was this page helpful?