az webapp 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 web app.
Commands
Name | Description | Type | Status |
---|---|---|---|
az webapp config access-restriction |
Methods that show, set, add, and remove access restrictions on a webapp. |
Core | GA |
az webapp config access-restriction add |
Adds an Access Restriction to the webapp. |
Core | GA |
az webapp config access-restriction remove |
Removes an Access Restriction from the webapp. |
Core | GA |
az webapp config access-restriction set |
Sets if SCM site is using the same restrictions as the main site and default actions. |
Core | GA |
az webapp config access-restriction show |
Show Access Restriction settings for webapp. |
Core | GA |
az webapp config appsettings |
Configure web app settings. Updating or removing application settings will cause an app recycle. |
Core | GA |
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 backup |
Manage backups for web apps. |
Core | GA |
az webapp config backup create |
Create a backup of a web app. |
Core | GA |
az webapp config backup delete |
Delete a web app backup. |
Core | GA |
az webapp config backup list |
List backups of a web app. |
Core | GA |
az webapp config backup restore |
Restore a web app from a backup. |
Core | GA |
az webapp config backup show |
Show the backup schedule for a web app. |
Core | GA |
az webapp config backup update |
Configure a new backup schedule for a web app. |
Core | GA |
az webapp config connection-string |
Manage a web app's connection strings. |
Core | GA |
az webapp config connection-string delete |
Delete a web app's connection strings. |
Core | GA |
az webapp config connection-string list |
Get a web app's connection strings. |
Core | GA |
az webapp config connection-string set |
Update a web app's connection strings. |
Core | GA |
az webapp config container |
Manage an existing web app's container settings. |
Core | GA |
az webapp config container delete |
Delete an existing web app's container settings. |
Core | GA |
az webapp config container set |
Set an existing web app's container settings. |
Core | GA |
az webapp config container show |
Get details of a web app's container settings. |
Core | GA |
az webapp config hostname |
Configure hostnames for a web app. |
Core | GA |
az webapp config hostname add |
Bind a hostname to a web app. |
Core | GA |
az webapp config hostname delete |
Unbind a hostname from a web app. |
Core | GA |
az webapp config hostname get-external-ip |
Get the external-facing IP address for a web app. |
Core | GA |
az webapp config hostname list |
List all hostname bindings for a web app. |
Core | GA |
az webapp config set |
Set a web app's configuration. |
Core | GA |
az webapp config show |
Get the details of a web app's configuration. |
Core | GA |
az webapp config snapshot |
Manage web app snapshots. |
Core | GA |
az webapp config snapshot list |
List the restorable snapshots for a web app. |
Core | GA |
az webapp config snapshot restore |
Restore a web app snapshot. |
Core | GA |
az webapp config ssl |
Configure SSL certificates for web apps. |
Core and Extension | GA |
az webapp config ssl bind |
Bind an SSL certificate to a web app. |
Core | GA |
az webapp config ssl bind (appservice-kube extension) |
Bind an SSL certificate to a web app. |
Extension | GA |
az webapp config ssl create |
Create a Managed Certificate for a hostname in a webapp app. |
Core | Preview |
az webapp config ssl delete |
Delete an SSL certificate from a web app. |
Core | GA |
az webapp config ssl import |
Import an SSL or App Service Certificate to a web app from Key Vault. |
Core | GA |
az webapp config ssl list |
List SSL certificates for a web app. |
Core | GA |
az webapp config ssl show |
Show the details of an SSL certificate for a web app. |
Core | GA |
az webapp config ssl unbind |
Unbind an SSL certificate from a web app. |
Core | GA |
az webapp config ssl unbind (appservice-kube extension) |
Unbind an SSL certificate from a web app. |
Extension | GA |
az webapp config ssl upload |
Upload an SSL certificate to a web app. |
Core | GA |
az webapp config storage-account |
Manage a web app's Azure storage account configurations. (Linux Web Apps and Windows Containers Web Apps Only). |
Core | GA |
az webapp config storage-account add |
Add an Azure storage account configuration to a web app. (Linux Web Apps and Windows Containers Web Apps Only). |
Core | GA |
az webapp config storage-account delete |
Delete a web app's Azure storage account configuration. (Linux Web Apps and Windows Containers Web Apps Only). |
Core | GA |
az webapp config storage-account list |
Get a web app's Azure storage account configurations. (Linux Web Apps and Windows Containers Web Apps Only). |
Core | GA |
az webapp config storage-account update |
Update an existing Azure storage account configuration on a web app. (Linux Web Apps and Windows Containers Web Apps Only). |
Core | GA |
az webapp config set
Set a web app's configuration.
az webapp config set [--acr-identity]
[--acr-use-identity {false, true}]
[--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]
[--runtime]
[--slot]
[--startup-file]
[--subscription]
[--use-32bit-worker-process {false, true}]
[--vnet-route-all-enabled {false, true}]
[--web-sockets-enabled {false, true}]
[--windows-fx-version]
Examples
turn on "alwaysOn"
az webapp config set -g MyResourceGroup -n MyUniqueApp --always-on true
set configuration through a JSON file called params.json
az webapp config set -g MyResourceGroup -n MyUniqueApp --generic-configurations "@.\params.json"
Optional Parameters
Accept system or user assigned identity which will be set for acr image pull. Use '[system]' to refer system assigned identity, or a resource id to refer user assigned identity.
Enable or disable pull image from acr use managed identity.
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 web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>
.
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>
.
Canonicalized web runtime in the format of Framework:Version, e.g. "PHP:7.2".Use az webapp list-runtimes
for available list.
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.
A docker image name used for your windows container web app, e.g., microsoft/nanoserver:ltsc2016.
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 webapp config show
Get the details of a web app's configuration.
az webapp config show [--ids]
[--name]
[--resource-group]
[--slot]
[--subscription]
Examples
Get the details of a web app's configuration. (autogenerated)
az webapp config show --name MyWebapp --resource-group MyResourceGroup
Optional 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 web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>
.
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
https://aka.ms/ContentUserFeedback.
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:Submit and view feedback for