Microsoft.Web hostingEnvironments 2021-02-01

• Latest
• 2021-03-01
• 2021-02-01
• 2021-01-15
• 2021-01-01
• 2020-12-01
• 2020-10-01
• 2020-09-01
• 2020-06-01
• 2019-08-01
• 2018-02-01
• 2016-09-01
• 2015-08-01

The hostingEnvironments resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

For a list of changed properties in each API version, see change log.

Template format

To create a Microsoft.Web/hostingEnvironments resource, add the following Bicep or JSON to your template.

Bicep

resource symbolicname 'Microsoft.Web/hostingEnvironments@2021-02-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  properties: {
    clusterSettings: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    dedicatedHostCount: int
    dnsSuffix: 'string'
    frontEndScaleFactor: int
    internalLoadBalancingMode: 'string'
    ipsslAddressCount: int
    multiSize: 'string'
    userWhitelistedIpRanges: [
      'string'
    ]
    virtualNetwork: {
      id: 'string'
      subnet: 'string'
    }
    zoneRedundant: bool
  }
}

JSON

{
  "type": "Microsoft.Web/hostingEnvironments",
  "apiVersion": "2021-02-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "properties": {
    "clusterSettings": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "dedicatedHostCount": "int",
    "dnsSuffix": "string",
    "frontEndScaleFactor": "int",
    "internalLoadBalancingMode": "string",
    "ipsslAddressCount": "int",
    "multiSize": "string",
    "userWhitelistedIpRanges": [ "string" ],
    "virtualNetwork": {
      "id": "string",
      "subnet": "string"
    },
    "zoneRedundant": "bool"
  }
}

Property values

hostingEnvironments

Name	Description	Value
type	The resource type For Bicep, set this value in the resource declaration.	'Microsoft.Web/hostingEnvironments'
apiVersion	The resource api version For Bicep, set this value in the resource declaration.	'2021-02-01'
name	The resource name	string (required)
location	Resource Location.	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
kind	Kind of resource.	string
properties	Core resource properties	AppServiceEnvironment

AppServiceEnvironment

Name	Description	Value
clusterSettings	Custom settings for changing the behavior of the App Service Environment.	NameValuePair[]
dedicatedHostCount	Dedicated Host Count	int
dnsSuffix	DNS suffix of the App Service Environment.	string
frontEndScaleFactor	Scale factor for front-ends.	int
internalLoadBalancingMode	Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.	'None' 'Publishing' 'Web' 'Web, Publishing'
ipsslAddressCount	Number of IP SSL addresses reserved for the App Service Environment.	int
multiSize	Front-end VM size, e.g. "Medium", "Large".	string
userWhitelistedIpRanges	User added ip ranges to allow on ASE db	string[]
virtualNetwork	Description of the Virtual Network.	VirtualNetworkProfile (required)
zoneRedundant	Whether or not this App Service Environment is zone-redundant.	bool

NameValuePair

Name	Description	Value
name	Pair name.	string
value	Pair value.	string

VirtualNetworkProfile

Name	Description	Value
id	Resource id of the Virtual Network.	string (required)
subnet	Subnet within the Virtual Network.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
ILB App Service Environment with Azure Firewall	Resource Manager templates and parameters demonstrating how to deploy App Service environment with Azure Firewall integration
App Service Environment with Azure SQL backend	This template creates an App Service Environment with an Azure SQL backend along with private endpoints along with associated resources typically used in an private/isolated environment.
App Service Environment with Hosting Plan and Azure WebApp	Creates an App Service Environment v2 with an ILB Address in a existing virtual network that will be privately availible. The App Service Environment will contain a Hosting Plan and a Azure Web App
Create Azure App Service Environment With An Web App Added.	Creates an Azure App Service Environment inside A Virtual Network Subnet. This template also adds a Azure Web App inside the App Service Environment. Template originally authored by Callum Brankin of PixelPin
Create an App Service Environment	Creates an App Service Environment in your virtual network
SSL certificate for an ILB ASE or an ILB ASE v2	Configures the default SSL certificate for an ILB ASE or an ILB ASE v2
Create App Service Environment with an ILB Address	Creates an App Service Environment in your virtual network with a private internal load balancer address
Create an App Service Environment v2	Creates an App Service Environment v2 in your virtual network
Create App Service Environment v2 with an ILB Address	Creates an App Service Environment v2 in your virtual network with a private internal load balancer address
Create an AppServicePlan and App in an ASEv3	Create an AppServicePlan and App in an ASEv3