Configure an App Service app

1. In the Azure portal, search for and select App Services, and then select your app.

2. On the app's left menu, select Settings > Environment variables. Then select App settings.

   

   By default, values for app settings are hidden in the portal for security. To see a hidden value of an app setting, under Value, select Show value. To see the hidden values of all app settings, select Show values.

   Note

   Read/Write user permimssions are required to view this section in the Azure portal. RBAC built-in roles with sufficient permissions are Owner, Contributor, and Website Contributor. The Reader role alone would not be allowed to access this page.

3. To add a new app setting, select Add. To edit a setting, select the setting.

4. In the dialog, you can stick the setting to the current slot.

   Note

   In a default Linux app service or a custom Linux container, any nested JSON key structure in the app setting name needs to be configured differently for the key name. Replace any colon (:) with a double underscore (__). Replace any period (.) with a single underscore (_). For example, ApplicationInsights:InstrumentationKey needs to be configured in App Service as ApplicationInsights__InstrumentationKey for the key name.

5. When you finish, select Apply. Then select Apply on the Environment variables page.

Add or edit an app setting by using az webapp config app settings set:

az webapp config appsettings set --resource-group <group-name> --name <app-name> --settings <setting-name>="<value>"

Replace <setting-name> with the name of the setting. Replace <value> with the value to assign to the setting.

Show all settings and their values by using az webapp config appsettings list:

az webapp config appsettings list --resource-group <group-name> --name <app-name>

Remove one or more settings by using az webapp config app settings delete:

az webapp config appsettings delete --resource-group <group-name> --name <app-name> --setting-names {<setting-name1>,<setting-name2>,...}

Set one or more app settings by using Set-AzWebApp:

Set-AzWebApp -ResourceGroupName <group-name> -Name <app-name> -AppSettings @{"<setting-name1>"="<value1>"; "<setting-name2>"="<value2>";...}

This cmdlet replaces the entire set of app settings with the ones that you specify. To add or edit an app setting within an existing set, include the existing app settings in your input hash table by using the Get-AzWebApp cmdlet. For example:

# Get app configuration
$webapp=Get-AzWebApp -ResourceGroupName <group-name> -Name <app-name>

# Copy app settings to a new hash table
$appSettings = @{}
ForEach ($item in $webapp.SiteConfig.AppSettings) {
$appSettings[$item.Name] = $item.Value
}

# Add or edit one or more app settings
$appSettings['<setting-name1>'] = '<value1>'
$appSettings['<setting-name2>'] = '<value2>'

# Save changes
Set-AzWebApp -ResourceGroupName <group-name> -Name <app-name> -AppSettings $appSettings

To check if an app setting is slot specific, use Get-AzWebAppSlotConfigName:

Get-AzWebAppSlotConfigName -ResourceGroupName <group-name> -Name <app-name> | select AppSettingNames

To make one or more app settings slot specific, use Set-AzWebAppSlotConfigName:

Set-AzWebAppSlotConfigName -ResourceGroupName <group-name> -Name <app-name> -AppSettingNames <setting-name1>,<setting-name2>,...

1. Select Advanced edit.
2. Edit the settings in the text area.
3. When you finish, select OK. Then select Apply on the Environment variables page.

App settings have the following JSON formatting:

[
  {
    "name": "<key-1>",
    "value": "<value-1>",
    "slotSetting": false
  },
  {
    "name": "<key-2>",
    "value": "<value-2>",
    "slotSetting": false
  },
  ...
]

Run az webapp config app settings set with the name of the JSON file:

az webapp config appsettings set --resource-group <group-name> --name <app-name> --settings "@fileName.json"

The necessary file format is a JSON array of settings where the slot setting field is optional. For example:

[
  {
    "name": "key1",
    "slotSetting": false,
    "value": "value1"
  },
  {
    "name": "key2",
    "value": "value2"
  }
]

For convenience, you can save existing settings in a JSON file by using az webapp config appsettings list.

# Save the settings
az webapp config appsettings list --resource-group <group-name> --name <app-name>  > settings.json

# Edit the JSON file
...

# Update the app with the JSON file
az webapp config appsettings set --resource-group <group-name> --name <app-name> --settings @settings.json

It's not possible to edit app settings in bulk by using a JSON file with Azure PowerShell.

1. In the Azure portal, search for and select App Services, and then select your app.

2. On the app's left menu, select Settings > Environment variables. Then select Connection strings.

   By default, values for connection strings are hidden in the portal for security. To see a hidden value of a connection string, under Value, select Show value. To see the hidden values of all connection strings, select Show values.

3. To add a new connection string, select Add. To edit a connection string, select the connection string.

4. In the dialog, you can stick the connection string to the current slot.

5. When you finish, select Apply. Then select Apply on the Environment variables page.

Add or edit an app setting by using az webapp config connection-string set:

az webapp config connection-string set --resource-group <group-name> --name <app-name> --connection-string-type <type> --settings <string-name>='<value>'

Replace <string-name> with the name of the connection string. Replace <value> with the value to assign to the connection string. For possible values of <type> such as SQLAzure, see the CLI command documentation.

Show all connection strings and their values by using az webapp config connection-string list:

az webapp config connection-string list --resource-group <group-name> --name <app-name>

Remove one or more connection strings by using az webapp config connection-string delete:

az webapp config connection-string delete --resource-group <group-name>  --name <app-name>--setting-names {<string-name1>,<string-name2>,...}

Set one or more connection strings by using Set-AzWebApp:

$PropertiesObject = @{
  "<string-name1>" = @{
    value="<connection-string1>";
    type="<type>"};
  "<string-name2>" = @{
    value="<connection-string2>";
    type="<type>"}
}

Set-AzWebApp -ResourceGroupName <group-name> -Name <app-name> -ConnectionStrings $PropertiesObject

Each connection string contains a name (<string-name1>), a value (<connection-string1>), and the type. The type is a numerical value that corresponds to one of the ConnectionStringType enumerator fields. For example, for Azure SQL, specify type="2".

This cmdlet replaces the entire set of connection strings with the ones that you specify. To add or edit an app setting within an existing set, include the existing app settings in your input hash table by using the Get-AzWebApp cmdlet. For example:

# Get app configuration
$webapp=Get-AzWebApp -ResourceGroupName <group-name> -Name <app-name>

# Copy connection strings to a new hash table
$connStrings = @{}
ForEach ($item in $webapp.SiteConfig.ConnectionStrings) {
    $connStrings[$item.Name] = @{value=$item.ConnectionString; type=$item.Type.ToString()}
}

# Add or edit one or more connection strings
$connStrings['<string-name1>'] = @{value='<connection-string1>'; type='<type>'}
$connStrings['<string-name2>'] = @{value='<connection-string2>'; type='<type>'}

# Save changes
Set-AzWebApp -ResourceGroupName <group-name> -Name <app-name> -ConnectionStrings $connStrings

To check if a connection string is slot specific, use Get-AzWebAppSlotConfigName:

Get-AzWebAppSlotConfigName -ResourceGroupName <group-name> -Name <app-name> | select ConnectionStringNames

To make one or more connection strings slot specific, use Set-AzWebAppSlotConfigName:

Set-AzWebAppSlotConfigName -ResourceGroupName <group-name> -Name <app-name> -ConnectionStringNames <string-name1>,<string-name2>,...

1. Select Advanced edit.
2. Edit the connection strings in the text area.
3. When you finish, select Apply. Don't forget to also select Apply on the Environment variables page.

Connection strings have the following JSON formatting:

[
  {
    "name": "name-1",
    "value": "conn-string-1",
    "type": "SQLServer",
    "slotSetting": false
  },
  {
    "name": "name-2",
    "value": "conn-string-2",
    "type": "PostgreSQL",
    "slotSetting": false
  },
  ...
]

Run az webapp config connection-string set with the name of the JSON file:

az webapp config connection-string set --resource-group <group-name> --name <app-name> --settings "@fileName.json"

The necessary file format is a JSON array of connection strings where the slot setting field is optional. For example:

[
  {
    "name": "name-1",
    "value": "conn-string-1",
    "type": "SQLServer",
    "slotSetting": false
  },
  {
    "name": "name-2",
    "value": "conn-string-2",
    "type": "PostgreSQL",
  },
  ...
]

For convenience, you can save existing connection strings in a JSON file by using az webapp config connection-string list.

# Save the connection strings
az webapp config connection-string list --resource-group <group-name> --name <app-name> > settings.json

# Edit the JSON file
...

# Update the app with the JSON file
az webapp config connection-string set --resource-group <group-name> --name <app-name> --settings @settings.json

It's not possible to edit connection strings in bulk by using a JSON file with Azure PowerShell.

1. In the Azure portal, search for and select App Services, and then select your app.

2. On the app's left menu, select Settings > Configuration. Then select General settings.

   

Here, you can configure some common settings for the app. Some settings require you to scale up to higher pricing tiers.

• Stack settings: Configure settings for the software stack to run the app, including the language and SDK versions.

  For Linux apps, you can select the language runtime version and set an optional startup command.

• Platform settings: Configure settings for the hosting platform, including:

  • Platform: Choose 32-bit or 64-bit. For Windows apps only.

  • FTP state: Allow only FTPS, or disable FTP altogether.

  • HTTP version: Set to 2.0 to enable support for the HTTPS/2 protocol.

    Note

    Most modern browsers support the HTTP/2 protocol over TLS only. Unencrypted traffic continues to use HTTP/1.1. To ensure that client browsers connect to your app with HTTP/2, secure your custom DNS name. For more information, see Provide security for a custom DNS name with a TLS/SSL binding in App Service.

  • Web sockets: Configure for ASP.NET SignalR or socket.io, for example.

  • Always On: Turn on if you want to keep the app loaded even when there's no traffic.

    When Always On is turned off (default), the app is unloaded after 20 minutes without any incoming requests. The unloaded app can cause high latency for new requests because of its warm-up time.

    When Always On is turned on, the front-end load balancer sends a GET request to the application root every five minutes. The continuous ping prevents the app from being unloaded.

    Always On is required for continuous WebJobs or for WebJobs that a cron expression triggers.

  • Session affinity: In a multiple-instance deployment, ensure that the client is routed to the same instance for the life of the session. You can set this option to Off for stateless applications.

  • Session affinity proxy: Turn on if your app is behind a reverse proxy (like Azure Application Gateway or Azure Front Door) and you're using the default host name. The domain for the session affinity cookie aligns with the forwarded host name from the reverse proxy.

  • HTTPS Only: Enable if you want to redirect all HTTP traffic to HTTPS.

  • Minimum TLS version: Select the minimum TLS encryption version that your app requires.

• Debugging: Enable remote debugging for ASP.NET, ASP.NET Core, or Node.js apps. This option turns off automatically after 48 hours.

• Incoming client certificates: Require client certificates in mutual authentication.

You can set many of the common configurable options by using az webapp config set. The following example shows a subset of the configurable options:

az webapp config set --resource-group <group-name> --name <app-name>  --use-32bit-worker-process [true|false] --web-sockets-enabled [true|false] --always-on [true|false]--http20-enabled --auto-heal-enabled [true|false] --remote-debugging-enabled [true|false] --number-of-workers

To show the existing settings, use the az webapp config show command.

You can set many of the common configurable options by using Set-AzWebApp. The following example shows a subset of the configurable options:

Set-AzWebApp -ResourceGroupName <group-name> -Name <app-name> -Use32BitWorkerProcess [$True|$False] -WebSocketsEnabled [$True|$False] -AlwaysOn [$True|$False] -NumberOfWorkers

To show the existing settings, use the Get-AzWebApp command.

1. In the Azure portal, search for and select App Services, and then select your app.
2. On the app's left menu, select Configuration. Then select Default documents.
3. To add a default document, select New document. To remove a default document, select Delete to its right.

Add a default document by using az resource update:

az resource update --resource-group <group-name> --resource-type "Microsoft.Web/sites/config" --name <app-name>/config/web --add properties.defaultDocuments <filename>

Add a default document by modifying the updating app's PowerShell object:

$webapp = Get-AzWebApp -ResourceGroupName <group-name> -Name <app-name>
$webapp.SiteConfig.DefaultDocuments.Add("<filename>")
Set-AzWebApp $webapp

1. In the Azure portal, search for and select App Services, and then select your app.

2. On the app's left menu, select Settings > Configuration. Then select Path mappings.

3. Select New virtual application or directory. Then take one of these actions:

   • To map a virtual directory to a physical path, leave Directory selected. Specify the virtual directory and the corresponding relative (physical) path to the website root (D:\home).
   • To mark a virtual directory as a web application, unselect Directory.

   

4. Select Ok. Then select Save on the Configuration page.

The following example sets the root path / to the public subdirectory, which works for Laravel. It also adds a second virtual application at the /app2 path. To run it, create a file called json.txt with the following contents:

[
  {
    "physicalPath"':' "site\\wwwroot\\public",
    "preloadEnabled"':' false,
    "virtualDirectories"':' null,
    "virtualPath"':' "/"
  },
  {
    "physicalPath"':' "site\\wwwroot\\app2",
    "preloadEnabled"':' false,
    "virtualDirectories"':' null,
    "virtualPath"':' "/app2"
  }
]

Change <group-name> and <app-name> for your resources and run the following command. Be aware of escape characters when you run this command. For more information on escape characters, see Tips for using the Azure CLI successfully.

az resource update --resource-group <group-name> --resource-type Microsoft.Web/sites/config --name <app-name>/config/web --set properties.virtualApplications="@json.txt"

The following example sets the root path / to the public subdirectory, which works for Laravel. It also adds a second virtual application at the /app2 path. To run it, change <group-name> and <app-name>.

$webapp=Get-AzWebApp -ResourceGroupName <group-name> -Name <app-name>

# Set default / path to public subdirectory
$webapp.SiteConfig.VirtualApplications[0].PhysicalPath= "site\wwwroot\public"

# Add a virtual application
$virtualApp = New-Object Microsoft.Azure.Management.WebSites.Models.VirtualApplication
$virtualApp.VirtualPath = "/app2"
$virtualApp.PhysicalPath = "site\wwwroot\app2"
$virtualApp.PreloadEnabled = $false
$webapp.SiteConfig.VirtualApplications.Add($virtualApp)

# Save settings
Set-AzWebApp $webapp