Microsoft.Web hostingEnvironments 2023-01-01

Bicep resource definition

The hostingEnvironments resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.Web/hostingEnvironments@2023-01-01' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    clusterSettings: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    customDnsSuffixConfiguration: {
      kind: 'string'
      properties: {
        certificateUrl: 'string'
        dnsSuffix: 'string'
        keyVaultReferenceIdentity: 'string'
      }
    }
    dedicatedHostCount: int
    dnsSuffix: 'string'
    frontEndScaleFactor: int
    internalLoadBalancingMode: 'string'
    ipsslAddressCount: int
    multiSize: 'string'
    networkingConfiguration: {
      kind: 'string'
      properties: {
        allowNewPrivateEndpointConnections: bool
        ftpEnabled: bool
        inboundIpAddressOverride: 'string'
        remoteDebugEnabled: bool
      }
    }
    upgradePreference: 'string'
    userWhitelistedIpRanges: [
      'string'
    ]
    virtualNetwork: {
      id: 'string'
      subnet: 'string'
    }
    zoneRedundant: bool
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AppServiceEnvironment

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

Microsoft.Web/hostingEnvironments

NameValuePair

ResourceTags

VirtualNetworkProfile

Quickstart samples

The following quickstart samples deploy this resource type.

ARM template resource definition

The hostingEnvironments resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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

Resource format

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

{
  "type": "Microsoft.Web/hostingEnvironments",
  "apiVersion": "2023-01-01",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "clusterSettings": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "customDnsSuffixConfiguration": {
      "kind": "string",
      "properties": {
        "certificateUrl": "string",
        "dnsSuffix": "string",
        "keyVaultReferenceIdentity": "string"
      }
    },
    "dedicatedHostCount": "int",
    "dnsSuffix": "string",
    "frontEndScaleFactor": "int",
    "internalLoadBalancingMode": "string",
    "ipsslAddressCount": "int",
    "multiSize": "string",
    "networkingConfiguration": {
      "kind": "string",
      "properties": {
        "allowNewPrivateEndpointConnections": "bool",
        "ftpEnabled": "bool",
        "inboundIpAddressOverride": "string",
        "remoteDebugEnabled": "bool"
      }
    },
    "upgradePreference": "string",
    "userWhitelistedIpRanges": [ "string" ],
    "virtualNetwork": {
      "id": "string",
      "subnet": "string"
    },
    "zoneRedundant": "bool"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AppServiceEnvironment

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

Microsoft.Web/hostingEnvironments

NameValuePair

ResourceTags

VirtualNetworkProfile

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
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 an App Service Environment	Creates an App Service Environment in your virtual network
Create an App Service Environment v2	Creates an App Service Environment v2 in your virtual network
Create an AppServicePlan and App in an ASEv3	Create an AppServicePlan and App in an ASEv3
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 App Service Environment with an ILB Address	Creates an App Service Environment in your virtual network with a private internal load balancer address
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
ILB App Service Environment with Azure Firewall	Resource Manager templates and parameters demonstrating how to deploy App Service environment with Azure Firewall integration
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

Terraform (AzAPI provider) resource definition

The hostingEnvironments resource type can be deployed with operations that target:

• Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/hostingEnvironments@2023-01-01"
  name = "string"
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      clusterSettings = [
        {
          name = "string"
          value = "string"
        }
      ]
      customDnsSuffixConfiguration = {
        kind = "string"
        properties = {
          certificateUrl = "string"
          dnsSuffix = "string"
          keyVaultReferenceIdentity = "string"
        }
      }
      dedicatedHostCount = int
      dnsSuffix = "string"
      frontEndScaleFactor = int
      internalLoadBalancingMode = "string"
      ipsslAddressCount = int
      multiSize = "string"
      networkingConfiguration = {
        kind = "string"
        properties = {
          allowNewPrivateEndpointConnections = bool
          ftpEnabled = bool
          inboundIpAddressOverride = "string"
          remoteDebugEnabled = bool
        }
      }
      upgradePreference = "string"
      userWhitelistedIpRanges = [
        "string"
      ]
      virtualNetwork = {
        id = "string"
        subnet = "string"
      }
      zoneRedundant = bool
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

AppServiceEnvironment

AseV3NetworkingConfiguration

AseV3NetworkingConfigurationProperties

CustomDnsSuffixConfiguration

CustomDnsSuffixConfigurationProperties

Microsoft.Web/hostingEnvironments

NameValuePair

ResourceTags

VirtualNetworkProfile