az functionapp config
Note
This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.
Configure a function app.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az functionapp config access-restriction |
Methods that show, set, add, and remove access restrictions on a functionapp. |
Core | GA |
| az functionapp config access-restriction add |
Adds an Access Restriction to the function app. |
Core | GA |
| az functionapp config access-restriction remove |
Removes an Access Restriction from the functionapp. |
Core | GA |
| az functionapp config access-restriction set |
Sets if SCM site is using the same restrictions as the main site. |
Core | GA |
| az functionapp config access-restriction show |
Show Access Restriction settings for functionapp. |
Core | GA |
| az functionapp config appsettings |
Configure function app settings. |
Core | GA |
| 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 container |
Manage an existing function app's container settings. |
Core and Extension | GA |
| az functionapp config container delete |
Delete an existing function app's container settings. |
Core | GA |
| az functionapp config container set |
Set an existing function app's container settings. |
Core | GA |
| az functionapp config container set (appservice-kube extension) |
Set an existing function app's container settings. |
Extension | GA |
| az functionapp config container show |
Get details of a function app's container settings. |
Core | GA |
| az functionapp config hostname |
Configure hostnames for a function app. |
Core | GA |
| az functionapp config hostname add |
Bind a hostname to a function app. |
Core | GA |
| az functionapp config hostname delete |
Unbind a hostname from a function app. |
Core | GA |
| az functionapp config hostname get-external-ip |
Get the external-facing IP address for a function app. |
Core | GA |
| az functionapp config hostname list |
List all hostname bindings for a function app. |
Core | GA |
| az functionapp config set |
Set an existing function app's configuration. |
Core | GA |
| az functionapp config show |
Get the details of an existing function app's configuration. |
Core | GA |
| az functionapp config ssl |
Configure SSL certificates. |
Core | GA |
| az functionapp config ssl bind |
Bind an SSL certificate to a function app. |
Core | GA |
| az functionapp config ssl create |
Create a Managed Certificate for a hostname in a function app. |
Core | Preview |
| az functionapp config ssl delete |
Delete an SSL certificate from a function app. |
Core | GA |
| az functionapp config ssl import |
Import an SSL certificate to a function app from Key Vault. |
Core | GA |
| az functionapp config ssl list |
List SSL certificates for a function app. |
Core | GA |
| az functionapp config ssl show |
Show the details of an SSL certificate for a function app. |
Core | GA |
| az functionapp config ssl unbind |
Unbind an SSL certificate from a function app. |
Core | GA |
| az functionapp config ssl upload |
Upload an SSL certificate to a function app. |
Core | GA |
az functionapp config set
Set an existing function app's configuration.
az functionapp config set [--always-on {false, true}]
[--auto-heal-enabled {false, true}]
[--ftps-state {AllAllowed, Disabled, FtpsOnly}]
[--generic-configurations]
[--http20-enabled {false, true}]
[--ids]
[--java-container]
[--java-container-version]
[--java-version]
[--linux-fx-version]
[--min-tls-version]
[--name]
[--net-framework-version]
[--number-of-workers]
[--php-version]
[--powershell-version]
[--prewarmed-instance-count]
[--python-version]
[--remote-debugging-enabled {false, true}]
[--resource-group]
[--slot]
[--startup-file]
[--subscription]
[--use-32bit-worker-process {false, true}]
[--vnet-route-all-enabled {false, true}]
[--web-sockets-enabled {false, true}]Examples
Set the function app's configuration. (autogenerated)
az functionapp config set --always-on true --name MyFunctionApp --resource-group MyResourceGroupset configuration through a JSON file called params.json
az functionapp config set -g MyResourceGroup -n MyFunctionApp --generic-configurations "@.\params.json"Optional Parameters
Ensure web app gets loaded all the time, rather unloaded after been idle. Recommended when you have continuous web jobs running.
Enable or disable auto heal.
Set the Ftps state value for an app. Default value is 'AllAllowed'.
Provide site configuration list in a format of either key=value pair or @<json_file>. PowerShell and Windows Command Prompt users should use a JSON file to provide these configurations to avoid compatibility issues with escape characters.
Configures a web site to allow clients to connect over http2.0.
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.
The java container, e.g., Tomcat, Jetty.
The version of the java container, e.g., '8.0.23' for Tomcat.
The version used to run your web app if using Java, e.g., '1.7' for Java 7, '1.8' for Java 8.
The runtime stack used for your linux-based webapp, e.g., "RUBY|2.5.5", "NODE|12LTS", "PHP|7.2", "DOTNETCORE|2.1". See https://aka.ms/linux-stacks for more info.
The minimum version of TLS required for SSL requests, e.g., '1.0', '1.1', '1.2'.
Name of the function app.
The version used to run your web app if using .NET Framework, e.g., 'v4.0' for .NET 4.6 and 'v3.0' for .NET 3.5.
The number of workers to be allocated.
The version used to run your web app if using PHP, e.g., 5.5, 5.6, 7.0.
The version used to run your function app if using PowerShell, e.g., 7.2.
Number of pre-warmed instances a function app has.
The version used to run your web app if using Python, e.g., 2.7, 3.4.
Enable or disable remote debugging.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the slot. Default to the productions slot if not specified.
The startup file for linux hosted web apps, e.g. 'process.json' for Node.js web.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Use 32 bits worker process or not.
Configure regional VNet integration to route all traffic to the VNet.
Enable or disable web sockets.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp config show
Get the details of an existing function app's configuration.
az functionapp config show [--ids]
[--name]
[--resource-group]
[--slot]
[--subscription]Examples
Get the details of a web app's configuration. (autogenerated)
az functionapp config show --name MyFunctionApp --resource-group MyResourceGroupOptional Parameters
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 of the function app.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the slot. Default to the productions slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for