Skip to content

Commit 301940c

Browse files
ShannonLeavittShannonLeavitt
authored
Merge pull request #312568 from GitHubber17/544920-c
Freshness Pass: App Service
2 parents 53798a8 + 8a24f14 commit 301940c

1 file changed

Lines changed: 75 additions & 42 deletions

File tree

‎articles/app-service/environment/how-to-create-from-template.md‎

Lines changed: 75 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,60 @@
11
---
2-
title: Create an App Service Environment (ASE) v3 with Azure Resource Manager
3-
description: Learn how to create an external or ILB App Service Environment v3 by using an Azure Resource Manager template.
2+
title: Create App Service Environment Using ARM Template
3+
description: Learn how to create an external or internal load balancer (ILB) App Service Environment v3 by using a customized Azure Resource Manager template.
44
author: seligj95
55
ms.topic: how-to
66
ms.custom: devx-track-arm-template
7-
ms.date: 03/09/2023
7+
ms.date: 03/04/2026
88
ms.author: jordanselig
99
ms.service: azure-app-service
10+
#customer intent: As a developer, I want to customize an ARM template for deploying an App Service Environment v3, so I can reuse the template to deploy environments in the future.
1011
---
1112
# Create an App Service Environment by using an Azure Resource Manager template
1213

13-
App Service Environment can be created using an Azure Resource Manager template allowing you to do repeatable deployment.
14+
An App Service Environment v3 can be created in the Azure portal or by using an Azure Resource Manager (ARM) template.
1415

15-
## Overview
16+
In the Azure portal, you create an App Service Environment with a specific configuration for immediate deployment. When you [create the environment in the portal](creation.md), you select or create the supporting resources at the same time, including the resource group for the deployment region, and the virtual network with subnet.
1617

17-
Azure App Service Environment can be created with an internet-accessible endpoint or an endpoint on an internal address in an Azure Virtual Network. When created with an internal endpoint, that endpoint is provided by an Azure component called an internal load balancer (ILB). The App Service Environment on an internal IP address is called an ILB ASE. The App Service Environment with a public endpoint is called an External ASE.
18+
When you create an App Service Environment from a template, you access a configuration that's available for repeatable deployment of the same environment or other App Service Environments. The template specifies the property set for the App Service Environment, along with the virtual network and subnet to use for the deployment.
1819

19-
An ASE can be created by using the Azure portal or an Azure Resource Manager template. This article walks through the steps and syntax you need to create an External ASE or ILB ASE with Resource Manager templates. Learn [how to create an App Service Environment in Azure portal](./creation.md).
20+
This article walks through the steps and syntax you need to create an External App Service Environment or internal load balancer (ILB) App Service Environment from an ARM template.
2021

21-
When you create an App Service Environment in the Azure portal, you can create your virtual network at the same time or choose a pre-existing virtual network to deploy into.
22+
## Prerequisites
2223

23-
When you create an App Service Environment from a template, you must start with:
24+
- To build the App Service Environment ARM template, you need to determine the type of environment to configure. You can create the environment with an internet-accessible endpoint or an endpoint on an internal address in an Azure Virtual Network instance.
2425

25-
* An Azure Virtual Network.
26-
* A subnet in that virtual network. We recommend a subnet size of `/24` with 256 addresses to accommodate future growth and scaling needs. After the App Service Environment is created, you can't change the size.
27-
* The location you want to deploy into.
26+
When the environment is created with an internal endpoint, the endpoint is provided by an Azure component, the _internal load balancer (ILB)_. An App Service Environment on an internal IP address is referred to as an _ILB App Service Environment_. An App Service Environment with a public endpoint is referred to as an _External App Service Environment_.
2827

29-
## Configuring the App Service Environment
28+
- The virtual network specified in the template must define a subnet:
3029

31-
The basic Resource Manager template that creates an App Service Environment looks like this:
30+
- The recommended subnet size is `/24` with 256 addresses to accommodate future growth and scaling needs.
31+
- The subnet must be empty, which means no network interface cards (NICs), virtual machines, private endpoints, and so on.
32+
- The subnet must be delegated to `Microsoft.Web/hostingEnvironments`.
33+
34+
Keep in mind that after you create an App Service Environment with the template, you can't change the subnet size.
35+
36+
- When you create an App Service Environment from an ARM template, the resource group you specify must be in a region that has sufficient availability to support deployment of the environment created from the template.
37+
38+
## Review the ARM template properties
39+
40+
The following JSON shows a basic ARM template that creates an App Service Environment.
3241

3342
```json
3443
{
44+
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
45+
"contentVersion": "1.0.0.0",
46+
"parameters": {
47+
"aseName": {
48+
"type": "string"
49+
},
50+
"subnetResourceId": {
51+
"type": "string"
52+
}
53+
},
54+
"variables": {},
55+
"resources": [
3556
"type": "Microsoft.Web/hostingEnvironments",
36-
"apiVersion": "2022-03-01",
57+
"apiVersion": "2025-03-01",
3758
"name": "[parameters('aseName')]",
3859
"location": "[resourceGroup().location]",
3960
"kind": "ASEV3",
@@ -51,44 +72,56 @@ The basic Resource Manager template that creates an App Service Environment look
5172
}
5273
```
5374

54-
In addition to the core properties, there are other configuration options that you can use to configure your App Service Environment.
55-
56-
* *name*: Required. This parameter defines a unique App Service Environment name. The name must be no more than 36 characters.
57-
* *virtualNetwork -> id*: Required. Specifies the resource ID of the subnet. Subnet must be empty and delegated to Microsoft.Web/hostingEnvironments
58-
* *internalLoadBalancingMode*: Required. In most cases, set this property to "Web, Publishing", which means both HTTP/HTTPS traffic and FTP traffic is on an internal VIP (Internal Load Balancer). If this property is set to "None", all traffic remains on the public VIP (External Load Balancer).
59-
* *zoneRedundant*: Optional. Defines with true/false if the App Service Environment will be deployed into Availability Zones (AZ). For more information, see [Regions and availability zones](./overview-zone-redundancy.md).
60-
* *dedicatedHostCount*: Optional. In most cases, set this property to 0 or left out. You can set it to 2 if you want to deploy your App Service Environment with physical hardware isolation on dedicated hosts.
61-
* *upgradePreference*: Optional. Defines if upgrade is started automatically or a 15 day windows to start the deployment is given. Valid values are "None", "Early", "Late", "Manual". More information [about upgrade preference](./how-to-upgrade-preference.md).
62-
* *clusterSettings*: Optional. For more information, see [cluster settings](./app-service-app-service-environment-custom-settings.md).
63-
* *networkingConfiguration -> allowNewPrivateEndpointConnections*: Optional. For more information, see [networking configuration](./configure-network-settings.md#allow-new-private-endpoint-connections).
64-
* *networkingConfiguration -> remoteDebugEnabled*: Optional. For more information, see [networking configuration](./configure-network-settings.md#remote-debugging-access).
65-
* *networkingConfiguration -> ftpEnabled*: Optional. For more information, see [networking configuration](./configure-network-settings.md#ftp-access).
66-
* *networkingConfiguration -> inboundIpAddressOverride*: Optional. Allow you to create an App Service Environment with your own Azure Public IP address (specify the resource ID) or define a static IP for ILB deployments. This setting can't be changed after the App Service Environment is created.
67-
* *customDnsSuffixConfiguration*: Optional. Allows you to specify a custom domain suffix for the App Service Environment. Requires a valid certificate from a Key Vault and access using a Managed Identity. For more information about the specific parameters, see [configuration custom domain suffix](./how-to-custom-domain-suffix.md).
75+
The following table describes the core properties and other options you can use to configure your App Service Environment.
76+
77+
| Property | Required | Description |
78+
| --- | :---: | --- |
79+
| `name` | Yes | Define a unique App Service Environment name. The name must be a string of no more than 36 characters. |
80+
| `virtualNetwork` -> `id` | Yes | Specify the resource ID of the subnet. The subnet must be empty and delegated to `Microsoft.Web/hostingEnvironments`. |
81+
| `internalLoadBalancingMode` | Yes | Identify the type of load balancer for the ILB App Service Environment.<br> - The most common value is `Web, Publishing`, which means both HTTP/HTTPS traffic and FTP traffic is on an internal VIP (Internal Load Balancer).<br> - When the value is `None`, all traffic remains on the public VIP (External Load Balancer). |
82+
| `zoneRedundant` | No | Indicate whether the App Service Environment is deployable to an availability zone. The value is boolean True or False. For more information, see [Reliability in Azure App Service](/azure/reliability/reliability-app-service). |
83+
| `dedicatedHostCount` | No | Specify how many hosts to dedicate for the App Service Environment.<br> - The most common value is 0 or unspecified.<br> - To deploy your App Service Environment with physical hardware isolation on dedicated hosts, set the value to 2. |
84+
| `upgradePreference` | No | Specify your preference for automatic upgrades. There are four possible values:<br> `None`: (Default) Upgrade automatically during the upgrade process for the region.<br> - `Early`: Upgrade automatically with a high prioritization compared with other resources in the region.<br> - `Late`: Upgrade automatically with a low prioritization compared with other resources in the region.<br> - `Manual`: Receive a notification when an upgrade is available, and start the process within 15 days. After 15 days, the upgrade occurs with other automatic upgrades in the region.<br> For more information, see [Upgrade preference for App Service Environment planned maintenance](how-to-upgrade-preference.md). |
85+
| `clusterSettings` | No | Customize the behavior of the App Service Environment. For more information, see [Custom configuration settings for App Service Environments](app-service-app-service-environment-custom-settings.md). |
86+
| `networkingConfiguration` -> `allowNewPrivateEndpointConnections` | No | Specify whether to allow creation of a new private endpoint connection for an ILB App Service Environment or External App Service Environment. By default, the option is disabled. For more information, see [Network configuration settings > Allow new private endpoint connections](configure-network-settings.md#allow-new-private-endpoint-connections). |
87+
| `networkingConfiguration` -> `remoteDebugEnabled` | No | Specify whether to enable remote debugging for the App Service Environment. By default, the option is disabled. For more information, see [Network configuration settings > Remote debugging access](configure-network-settings.md#remote-debugging-access). |
88+
| `networkingConfiguration` -> `ftpEnabled` | No | Specify whether to allow FTP connections to the App Service Environment. By default, the option is disabled. For more information, see [Network configuration settings > FTP access](configure-network-settings.md#ftp-access). |
89+
| `networkingConfiguration` -> `inboundIpAddressOverride` | No | Use this setting to create an App Service Environment with your own Azure Public IP address (specify the resource ID) or define a static IP for ILB deployments. This setting can't be changed after the App Service Environment is created. |
90+
| `customDnsSuffixConfiguration` | No | Use this setting to specify a custom domain suffix for the App Service Environment. For more information about the specific parameters, see [Custom domain suffix for App Service Environments](how-to-custom-domain-suffix.md).<br> **Important**: To set this option, you must have an existing key vault, a valid certificate secret from Azure Key Vault, and access with a managed identity for Azure resources through Microsoft Entra ID. |
6891

6992
> [!NOTE]
70-
> The properties `dnsSuffix`, `multiSize`, `frontEndScaleFactor`, `userWhitelistedIpRanges`, and `ipSslAddressCount` are not supported when creating App Service Environment v3.
93+
> An App Service Environment v3 doesn't support the following properties: `dnsSuffix`, `multiSize`, `frontEndScaleFactor`, `userWhitelistedIpRanges`, and `ipSslAddressCount`.
94+
95+
## Create the ARM template
7196

72-
### Deploying the App Service Environment
97+
Create the template by following these steps:
7398

74-
After creating the ARM template, for example named *azuredeploy.json* and optionally a parameters file for example named *azuredeploy.parameters.json*, you can create the App Service Environment by using the Azure CLI code snippet. Change the file paths to match the Resource Manager template-file locations on your machine. Remember to supply your own value for the resource group name:
99+
1. Paste the sample ARM template into a new JSON file and modify the properties for your configuration.
100+
101+
1. Save the JSON file, such as *azuredeploy.json*. Note the file save location for later use.
102+
103+
1. (Optional) Relocate the parameter settings from the template JSON file into a parameters JSON file, such as *azuredeploy.parameters.json*. Note the file save location for later use.
104+
105+
## Deploy the App Service Environment
106+
107+
After you prepare the template, you can create the App Service Environment from the template by using the Azure CLI.
108+
109+
Update the `templatePath` and `parameterPath` values to point to the locations of your ARM template file and parameters file on your machine. Enter the name of your resource group for the `<resource_group>` value.
75110

76111
```azurecli
77112
templatePath="PATH/azuredeploy.json"
78113
parameterPath="PATH/azuredeploy.parameters.json"
79114

80-
az deployment group create --resource-group "YOUR-RG-NAME-HERE" --template-file $templatePath --parameters $parameterPath
115+
az deployment group create --resource-group <resource_group> --template-file $templatePath --parameters $parameterPath
81116
```
82117

83-
Creating the App Service Environment usually takes about an hour, but if it is a zone redundant App Service Environment or we are experiencing unexpected demand in a region, the creation process can take several hours to complete.
84-
85-
## Next steps
118+
> [!TIP]
119+
> It's helpful to confirm your template can successfully create the App Service Environment before you run the `az deployment group create` command. Validate the template by running the `az deployment group validate` command with your resource values.
86120

87-
> [!div class="nextstepaction"]
88-
> [Using an App Service Environment v3](./using.md)
121+
Creating the App Service Environment usually takes about an hour, but if it's a zone-redundant App Service Environment or the target region is experiencing unexpected demand, the creation process can take several hours to complete.
89122

90-
> [!div class="nextstepaction"]
91-
> [App Service Environment v3 Networking](./networking.md)
123+
## Related content
92124

93-
> [!div class="nextstepaction"]
94-
> [Certificates in App Service Environment v3](./overview-certificates.md)
125+
- [Use an App Service Environment](using.md)
126+
- [App Service Environment networking](networking.md)
127+
- [Certificates and the App Service Environment](overview-certificates.md)

0 commit comments

Comments
 (0)