Microsoft.Web serverfarms 2024-04-01

• Latest
• 2024-04-01
• 2023-12-01
• 2023-01-01
• 2022-09-01
• 2022-03-01
• 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

Bicep resource definition

The serverfarms 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/serverfarms resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/serverfarms@2024-04-01' = {
  extendedLocation: {
    name: 'string'
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    elasticScaleEnabled: bool
    freeOfferExpirationTime: 'string'
    hostingEnvironmentProfile: {
      id: 'string'
    }
    hyperV: bool
    isSpot: bool
    isXenon: bool
    kubeEnvironmentProfile: {
      id: 'string'
    }
    maximumElasticWorkerCount: int
    perSiteScaling: bool
    reserved: bool
    spotExpirationTime: 'string'
    targetWorkerCount: int
    targetWorkerSizeId: int
    workerTierName: 'string'
    zoneRedundant: bool
  }
  sku: {
    capabilities: [
      {
        name: 'string'
        reason: 'string'
        value: 'string'
      }
    ]
    capacity: int
    family: 'string'
    locations: [
      'string'
    ]
    name: 'string'
    size: 'string'
    skuCapacity: {
      default: int
      elasticMaximum: int
      maximum: int
      minimum: int
      scaleType: 'string'
    }
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AppServicePlanProperties

Name	Description	Value
elasticScaleEnabled	ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku	bool
freeOfferExpirationTime	The time when the server farm free offer expires.	string
hostingEnvironmentProfile	Specification for the App Service Environment to use for the App Service plan.	HostingEnvironmentProfile
hyperV	If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.	bool
isSpot	If <code>true</code>, this App Service Plan owns spot instances.	bool
isXenon	Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.	bool
kubeEnvironmentProfile	Specification for the Kubernetes Environment to use for the App Service plan.	KubeEnvironmentProfile
maximumElasticWorkerCount	Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan	int
perSiteScaling	If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan.	bool
reserved	If Linux app service plan <code>true</code>, <code>false</code> otherwise.	bool
spotExpirationTime	The time when the server farm expires. Valid only if it is a spot server farm.	string
targetWorkerCount	Scaling worker count.	int
targetWorkerSizeId	Scaling worker size ID.	int
workerTierName	Target worker tier assigned to the App Service plan.	string
zoneRedundant	If <code>true</code>, this App Service Plan will perform availability zone balancing. If <code>false</code>, this App Service Plan will not perform availability zone balancing.	bool

Capability

Name	Description	Value
name	Name of the SKU capability.	string
reason	Reason of the SKU capability.	string
value	Value of the SKU capability.	string

ExtendedLocation

Name	Description	Value
name	Name of extended location.	string

HostingEnvironmentProfile

Name	Description	Value
id	Resource ID of the App Service Environment.	string

KubeEnvironmentProfile

Name	Description	Value
id	Resource ID of the Kubernetes Environment.	string

Microsoft.Web/serverfarms

Name	Description	Value
extendedLocation	Extended Location.	ExtendedLocation
kind	Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.	string
location	Resource Location.	string (required)
name	The resource name	string (required)
properties	AppServicePlan resource specific properties	AppServicePlanProperties
sku	Description of a SKU for a scalable resource.	SkuDescription
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ResourceTags

Name	Description	Value

SkuCapacity

Name	Description	Value
default	Default number of workers for this App Service plan SKU.	int
elasticMaximum	Maximum number of Elastic workers for this App Service plan SKU.	int
maximum	Maximum number of workers for this App Service plan SKU.	int
minimum	Minimum number of workers for this App Service plan SKU.	int
scaleType	Available scale configurations for an App Service plan.	string

SkuDescription

Name	Description	Value
capabilities	Capabilities of the SKU, e.g., is traffic manager enabled?	Capability[]
capacity	Current number of instances assigned to the resource.	int
family	Family code of the resource SKU.	string
locations	Locations of the SKU.	string[]
name	Name of the resource SKU.	string
size	Size specifier of the resource SKU.	string
skuCapacity	Min, max, and default scale values of the SKU.	SkuCapacity
tier	Service tier of the resource SKU.	string

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
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
App Service Quickstart - Linux App	This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows app	This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows app	This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows container app	This template is to be used with /azure/app-service/quickstart-arm-template
Application Gateway with internal API Management and Web App	Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App.
Azure Cosmos DB Account with Web App	This template deploys an Azure Cosmos DB account, an App Service Plan, and creates a Web App in the App Service Plan. It also adds two Application settings to the Web App that reference the Azure Cosmos DB account endpoint. This way solutions deployed to the Web App can connect to the Azure Cosmos DB account endpoint using those settings.
Azure Digital Twins with Function and Private Link service	This template creates an Azure Digital Twins service configured with a Virtual Network connected Azure Function that can communicate through a Private Link Endpoint to Digital Twins. It also creates a Private DNS Zone to allow seamless hostname resolution of the Digital Twins Endpoint from the Virtual Network to the Private Endpoint internal subnet IP address. The hostname is stored as a setting to the Azure Function with name 'ADT_ENDPOINT'.
Azure Function app and an HTTP-triggered function	This example deploys an Azure Function app and an HTTP-triggered function inline in the template. It also deploys a Key Vault and populates a secret with the function app's host key.
Azure Function App Hosted on Linux Consumption Plan	This template provisions a function app on a Linux Consumption plan, which is a dynamic hosting plan. The app runs on demand and you're billed per execution, with no standing resource committment.
Azure Function App with a Deployment Slot	This template provisions a function app on a Premium plan with production slot and an additional deployment slot.
Azure Function App with Event Hub and Managed Identity	his template provisions an Azure Function app on a Linux Consumption plan, along with an Event Hub, Azure Storage, and Application Insights. The function app is able to use managed identity to connect to the Event Hub and Storage account
Azure Function App with Virtual Network Integration	This template provisions a function app on a Premium plan with regional virtual network integration enabled to a newly created virtual network.
Azure Traffic Manager web app example	This template shows how to create an Azure Traffic Manager profile for an App Service.
Build a Web App on Linux with Azure database for MySQL	This template provides a way to deploy Web Apps on Linux with Azure database for MySQL.
Create a CDN Profile, a CDN Endpoint and a Web App	This template creates a CDN Profile and a CDN Endpoint with a Web App as the origin
Create a web app on Azure with Java 13 and Tomcat 9 enabled	This template creates a web app on azure with Java 13 and Tomcat 9 enabled allowing you to run Java applications in Azure. Template was authored by Donovan Brown of Microsoft.
Create a Web App plus Redis Cache using a template	This template creates an Azure Web App with Redis cache.
Create a Web App, PE and Application Gateway v2	This template creates an Azure Web App with Private endpoint in Azure Virtual Network Subnet , an Application Gateway v2. The Application Gateway is deployed in a vNet (subnet). The Web App restricts access to traffic from the subnet using private endpoint
Create a zero touch Azure Cosmos account and Azure Web App	This template creates an Azure Cosmos account, injects the Cosmos DB endpoint and keys into Azure Web App settings, then deploys an ASP MVC web app from GitHub.
Create Function App and private endpoint-secured Storage	This template allows you to deploy an Azure Function App that communicates with Azure Storage over private endpoints.
Deploy a basic Linux web app	This template allows you to deploy an app service plan and a basic Linux web app
Deploy an app service with regional VNet integration	This template allows you to deploy an app service plan and a basic Windows web app, with regional VNet integration enabled to a newly created virtual network
Deploy an AZ enabled Azure Function Premium plan	This template allows you to deploy an Azure Function Premium plan with availability zones support, including an availability zones enabled storage account.
Deploy an Azure Function Premium plan with vnet integration	This template allows you to deploy an Azure Function Premium plan with regional virtual network integration enabled to a newly created virtual network.
Django app	This template allows you to create an App Service for deploying a Django app.
Flask app service	This template allows you to create an App Service for deploying a Flask app.
Front Door Premium with App Service origin and Private Link	This template creates a Front Door Premium and an App Service, and uses a private endpoint for Front Door to send traffic to the application.
Front Door Standard/Premium with App Service origin	This template creates a Front Door Standard/Premium, an App Service, and configures the App Service to validate that traffic has come through the Front Door origin.
Front Door Standard/Premium with Azure Functions origin	This template creates a Front Door Standard/Premium, an Azure Functions app, and configures the function app to validate that traffic has come through the Front Door origin.
Function App	This template deploy an empty Function App and a hosting plan.
Function App secured by Azure Frontdoor	This template allows you to deploy an azure premium function protected and published by Azure Frontdoor premium. The conenction between Azure Frontdoor and Azure Functions is protected by Azure Private Link.
Highly Available Multi-region Web App	This template allows you to create a secure, highly available, multi-region end to end solution with two web apps in different regions behind Azure Front Door
Moesif API Analytics and Monetization	The template will log API calls from Azure API Management to Moesif API analytics and monetization platform
Private Function App and private endpoint-secured Storage	This template provisions a function app on a Premium plan that has private endpoints and communicates with Azure Storage over private endpoints.
Provision a function app on a Consumption plan	This template provisions a function app on a Consumption plan, which is a dynamic hosting plan. The app runs on demand and you're billed per execution, with no standing resource committment. There are other templates available for provisioning on a dedicated hosting plan.
Provision a function app running on an App Service Plan	This template provisions a function app on a dedicated hosting plan, meaning it will be run and billed just like any App Service site.
Provision a Web App with a SQL Database	This template provisions a Web App, a SQL Database, AutoScale settings, Alert rules, and App Insights. It configures a connection string in the web app for the database.
Provision Consumption plan function with a Deployment Slot	This template provisions a function app on a Consumption plan, which is a dynamic hosting plan. The app runs on demand and you're billed per execution, with no standing resource committment. There are other templates available for provisioning on a dedicated hosting plan.
Secure N-tier Web App	This template allows you to create a secure end to end solution with two web apps with staging slots, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint
Sonarqube Docker Web App on Linux with Azure SQL	This template deploys Sonarqube in an Azure App Service web app Linux container using the official Sonarqube image and backed by an Azure SQL Server.
Sonarqube Docker Web App on Linux with PostgreSQL	This template provides a easy way to deploy a Sonarqube docker image (alpine tag) on a Linux Web App with Azure database for PostgreSQL(Preview)
SonarQube on Web App with PostgreSQL and VNet integration	This template provides easy to deploy SonarQube to Web App on Linux with PostgreSQL Flexible Server, VNet integration and private DNS.
Web App Deployment from GitHub	This template allows you to create an WebApp linked with a GitHub Repository linked.
Web App w/ Application Insights sending to Log Analytics	This template will is to help support the new API versions of microsoft.insights/components. Starting with 2020-02-02-preview WorkspaceID will be required when creating Application Inisghts.This template will deploy the App Service Plan, App Service, Application Insights, Log Analytics Workspace and hook it all together.
Web App with Azure database for MySQL	This template provides a easy way to deploy web app on Azure App Service Web Apps with Azure database for MySQL.
Web App with Managed Identity, SQL Server and ΑΙ	Simple example to deploy Azure infrastructure for app + data + managed identity + monitoring
Web App with VNet Injection and Private Endpoint	This template allows you to create a secure end to end solution with two web apps, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint

ARM template resource definition

The serverfarms 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/serverfarms resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/serverfarms",
  "apiVersion": "2024-04-01",
  "name": "string",
  "extendedLocation": {
    "name": "string"
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "elasticScaleEnabled": "bool",
    "freeOfferExpirationTime": "string",
    "hostingEnvironmentProfile": {
      "id": "string"
    },
    "hyperV": "bool",
    "isSpot": "bool",
    "isXenon": "bool",
    "kubeEnvironmentProfile": {
      "id": "string"
    },
    "maximumElasticWorkerCount": "int",
    "perSiteScaling": "bool",
    "reserved": "bool",
    "spotExpirationTime": "string",
    "targetWorkerCount": "int",
    "targetWorkerSizeId": "int",
    "workerTierName": "string",
    "zoneRedundant": "bool"
  },
  "sku": {
    "capabilities": [
      {
        "name": "string",
        "reason": "string",
        "value": "string"
      }
    ],
    "capacity": "int",
    "family": "string",
    "locations": [ "string" ],
    "name": "string",
    "size": "string",
    "skuCapacity": {
      "default": "int",
      "elasticMaximum": "int",
      "maximum": "int",
      "minimum": "int",
      "scaleType": "string"
    },
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AppServicePlanProperties

Name	Description	Value
elasticScaleEnabled	ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku	bool
freeOfferExpirationTime	The time when the server farm free offer expires.	string
hostingEnvironmentProfile	Specification for the App Service Environment to use for the App Service plan.	HostingEnvironmentProfile
hyperV	If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.	bool
isSpot	If <code>true</code>, this App Service Plan owns spot instances.	bool
isXenon	Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.	bool
kubeEnvironmentProfile	Specification for the Kubernetes Environment to use for the App Service plan.	KubeEnvironmentProfile
maximumElasticWorkerCount	Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan	int
perSiteScaling	If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan.	bool
reserved	If Linux app service plan <code>true</code>, <code>false</code> otherwise.	bool
spotExpirationTime	The time when the server farm expires. Valid only if it is a spot server farm.	string
targetWorkerCount	Scaling worker count.	int
targetWorkerSizeId	Scaling worker size ID.	int
workerTierName	Target worker tier assigned to the App Service plan.	string
zoneRedundant	If <code>true</code>, this App Service Plan will perform availability zone balancing. If <code>false</code>, this App Service Plan will not perform availability zone balancing.	bool

Capability

Name	Description	Value
name	Name of the SKU capability.	string
reason	Reason of the SKU capability.	string
value	Value of the SKU capability.	string

ExtendedLocation

Name	Description	Value
name	Name of extended location.	string

HostingEnvironmentProfile

Name	Description	Value
id	Resource ID of the App Service Environment.	string

KubeEnvironmentProfile

Name	Description	Value
id	Resource ID of the Kubernetes Environment.	string

Microsoft.Web/serverfarms

Name	Description	Value
apiVersion	The api version	'2024-04-01'
extendedLocation	Extended Location.	ExtendedLocation
kind	Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.	string
location	Resource Location.	string (required)
name	The resource name	string (required)
properties	AppServicePlan resource specific properties	AppServicePlanProperties
sku	Description of a SKU for a scalable resource.	SkuDescription
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Web/serverfarms'

ResourceTags

Name	Description	Value

SkuCapacity

Name	Description	Value
default	Default number of workers for this App Service plan SKU.	int
elasticMaximum	Maximum number of Elastic workers for this App Service plan SKU.	int
maximum	Maximum number of workers for this App Service plan SKU.	int
minimum	Minimum number of workers for this App Service plan SKU.	int
scaleType	Available scale configurations for an App Service plan.	string

SkuDescription

Name	Description	Value
capabilities	Capabilities of the SKU, e.g., is traffic manager enabled?	Capability[]
capacity	Current number of instances assigned to the resource.	int
family	Family code of the resource SKU.	string
locations	Locations of the SKU.	string[]
name	Name of the resource SKU.	string
size	Size specifier of the resource SKU.	string
skuCapacity	Min, max, and default scale values of the SKU.	SkuCapacity
tier	Service tier of the resource SKU.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Airflow Docker Web App on Linux with PostgreSQL	This template provides a easy way to deploy a puckel/docker-airflow image (latest tag) on a Linux Web App with Azure database for PostgreSQL
Airflow Web App with PostgreSQL database on App Services	A template for deploying Airflow Web App with PostgreSQL database on App Services
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
App Service Quickstart - Linux App	This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows app	This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows app	This template is to be used with /azure/app-service/quickstart-arm-template
App Service Quickstart - Windows container app	This template is to be used with /azure/app-service/quickstart-arm-template
Application Gateway for a Web App with IP Restriction	This template creates an application gateway in front of an Azure Web App with IP restriction enabled on the Web App.
Application Gateway with internal API Management and Web App	Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App.
ASP.NET app	This template allows you to create an App Service for deploying a ASP.NET app.
Azure Cosmos DB Account with Web App	This template deploys an Azure Cosmos DB account, an App Service Plan, and creates a Web App in the App Service Plan. It also adds two Application settings to the Web App that reference the Azure Cosmos DB account endpoint. This way solutions deployed to the Web App can connect to the Azure Cosmos DB account endpoint using those settings.
Azure Digital Twins with Function and Private Link service	This template creates an Azure Digital Twins service configured with a Virtual Network connected Azure Function that can communicate through a Private Link Endpoint to Digital Twins. It also creates a Private DNS Zone to allow seamless hostname resolution of the Digital Twins Endpoint from the Virtual Network to the Private Endpoint internal subnet IP address. The hostname is stored as a setting to the Azure Function with name 'ADT_ENDPOINT'.
Azure Function app and an HTTP-triggered function	This example deploys an Azure Function app and an HTTP-triggered function inline in the template. It also deploys a Key Vault and populates a secret with the function app's host key.
Azure Function App Hosted on Dedicated Plan	This template provisions a function app on a dedicated hosting plan, meaning it will be run and billed just like any App Service site.
Azure Function App Hosted on Linux Consumption Plan	This template provisions a function app on a Linux Consumption plan, which is a dynamic hosting plan. The app runs on demand and you're billed per execution, with no standing resource committment.
Azure Function App Hosted on Premium Plan	This template provisions a function app on a Premium plan.
Azure Function App Hosted on Windows Consumption Plan	This template provisions a function app on a Windows Consumption plan, which is a dynamic hosting plan. The app runs on demand and you're billed per execution, with no standing resource committment.
Azure Function App with a Deployment Slot	This template provisions a function app on a Premium plan with production slot and an additional deployment slot.
Azure Function App with Event Hub and Managed Identity	his template provisions an Azure Function app on a Linux Consumption plan, along with an Event Hub, Azure Storage, and Application Insights. The function app is able to use managed identity to connect to the Event Hub and Storage account
Azure Function App with Virtual Network Integration	This template provisions a function app on a Premium plan with regional virtual network integration enabled to a newly created virtual network.
Azure Logic App with Function	This template creates a Serverless app in Azure with Logic Apps and Functions. The Logic App triggers on an HTTP POST, calls the Azure Function, and returns the response.
Azure Traffic Manager web app example	This template shows how to create an Azure Traffic Manager profile for an App Service.
Buffalo Web App	Start running your Golang Buffalo Application on Azure quickly and cheaply.
Build a Web App on Linux with Azure database for MySQL	This template provides a way to deploy Web Apps on Linux with Azure database for MySQL.
Call custom APIs from Azure Logic Apps	Although Logic Apps provides hundreds of connectors for various services, you might want to call APIs that run your own code. One of the easiest and most scalable ways to host your own web APIs is by using Azure App Service. This template deploys a Web app for your custom API and secures that API by using Azure Active Directory authentication.
Create a CDN Profile, a CDN Endpoint and a Web App	This template creates a CDN Profile and a CDN Endpoint with a Web App as the origin
Create a Web App + Redis Cache + SQL DB with a template	This template creates an Azure Web App with Redis cache and a SQL Database.
Create a web app on Azure with Java 13 and Tomcat 9 enabled	This template creates a web app on azure with Java 13 and Tomcat 9 enabled allowing you to run Java applications in Azure. Template was authored by Donovan Brown of Microsoft.
Create a web app on Azure with Python enabled	This template creates a web app on azure with Python enabled allowing you to run Python applications in Azure. Template was authored by Donovan Brown of Microsoft.
Create a Web App plus Redis Cache using a template	This template creates an Azure Web App with Redis cache.
Create a Web App protected by Application Gateway v2	This template creates an Azure Web App with Access Restriction for an Application Gateway v2. The Application Gateway is deployed in a vNet (subnet) which has a 'Microsoft.Web' Service Endpoint enabled. The Web App restricts access to traffic from the subnet.
Create a Web App, PE and Application Gateway v2	This template creates an Azure Web App with Private endpoint in Azure Virtual Network Subnet , an Application Gateway v2. The Application Gateway is deployed in a vNet (subnet). The Web App restricts access to traffic from the subnet using private endpoint
Create a zero touch Azure Cosmos account and Azure Web App	This template creates an Azure Cosmos account, injects the Cosmos DB endpoint and keys into Azure Web App settings, then deploys an ASP MVC web app from GitHub.
Create an AppServicePlan and App in an App. Service Env. v2	Create an AppServicePlan and App in an App Service Environment v2
Create an AppServicePlan and App in an ASE	Create an AppServicePlan and App in an ASE
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 Azure Web app with Blob Storage connection string	Creates an Azure Web app with Blob Storage connection string, Template originally authored by Jeff Bowles of Microsoft
Create Function App and private endpoint-secured Storage	This template allows you to deploy an Azure Function App that communicates with Azure Storage over private endpoints.
Creates a function app with managed service identity	Creates a function app with managed service identity enabled with Application Insights set up for logs and metrics.
Deploy a basic Linux web app	This template allows you to deploy an app service plan and a basic Linux web app
Deploy an app service with regional VNet integration	This template allows you to deploy an app service plan and a basic Windows web app, with regional VNet integration enabled to a newly created virtual network
Deploy an Autoscale Setting for App Service Plan	This template allows you to deploy an autoscale policy for Azure AppService Plan resource.
Deploy an AZ enabled Azure Function Premium plan	This template allows you to deploy an Azure Function Premium plan with availability zones support, including an availability zones enabled storage account.
Deploy an Azure Function Premium plan with vnet integration	This template allows you to deploy an Azure Function Premium plan with regional virtual network integration enabled to a newly created virtual network.
Django app	This template allows you to create an App Service for deploying a Django app.
Enterprise Governance-AppService, SQL DB, AD, OMS, Runbooks	Cloud adoption for an Enterprise, small or large, require responsible and efficient governance models to derive value from their cloud deployments. CloudWise (a code-name for the solution), is a composite solution available from Azure Partner QuickStarts, is an adoption enabler for Customers, System Integrators and Partners alike, that delivers a self-serviceable, automated governance and operations solution, focused on Optimizing Your Costs, Improve Your Application(s) Reliability, Reducing Business Risk. The solution highlights the core governance pillars of Visibility and Control.
EPiserverCMS in Azure	This template allows you to create resources required for EpiServerCMS deployment in Azure
eShop Website with ILB ASE	An App Service Environment is a Premium service plan option of Azure App Service that provides a fully isolated and dedicated environment for securely running Azure App Service apps at high scale, including Web Apps, Mobile Apps, and API Apps.
Flask app service	This template allows you to create an App Service for deploying a Flask app.
Front Door Premium with App Service origin and Private Link	This template creates a Front Door Premium and an App Service, and uses a private endpoint for Front Door to send traffic to the application.
Front Door Standard/Premium with App Service origin	This template creates a Front Door Standard/Premium, an App Service, and configures the App Service to validate that traffic has come through the Front Door origin.
Front Door Standard/Premium with Azure Functions origin	This template creates a Front Door Standard/Premium, an Azure Functions app, and configures the function app to validate that traffic has come through the Front Door origin.
Function App	This template deploy an empty Function App and a hosting plan.
Function App on Linux Consumption Plan with Remote Build	This template provisions a function app on a Linux Consumption plan and perform remote build during code deployment. The app runs on demand and you're billed per execution, with no standing resource committment.
Function App secured by Azure Frontdoor	This template allows you to deploy an azure premium function protected and published by Azure Frontdoor premium. The conenction between Azure Frontdoor and Azure Functions is protected by Azure Private Link.
Highly Available Multi-region Web App	This template allows you to create a secure, highly available, multi-region end to end solution with two web apps in different regions behind Azure Front Door
ILB App Service Environment with Azure Firewall	Resource Manager templates and parameters demonstrating how to deploy App Service environment with Azure Firewall integration
Java CI/CD using Jenkins and Azure Web Apps	This is a sample for Java CI/CD using Jenkins and Azure Web Apps.
Kentico Xperience	This template facilitates the deployment of resources required to host Kentico Xperience environments in Microsoft Azure.
Moesif API Analytics and Monetization	The template will log API calls from Azure API Management to Moesif API analytics and monetization platform
Node App Service	This template allows you to create an App Service for deploying a Node app.
Orchard CMS Video Portal Web App	This template provides a easy way to deploy Orchard CMS on Azure App Service Web Apps with the Azure Media Services module enabled and configured.
Private Function App and private endpoint-secured Storage	This template provisions a function app on a Premium plan that has private endpoints and communicates with Azure Storage over private endpoints.
Provision a function app on a Consumption plan	This template provisions a function app on a Consumption plan, which is a dynamic hosting plan. The app runs on demand and you're billed per execution, with no standing resource committment. There are other templates available for provisioning on a dedicated hosting plan.
Provision a function app running on an App Service Plan	This template provisions a function app on a dedicated hosting plan, meaning it will be run and billed just like any App Service site.
Provision a function app with source deployed from GitHub	This template deploys a Function App hosted in a new dedicated App Service Plan. The Function App has a child resource that enables continous integration and deploys the function code from a GitHub repository.
Provision a Mobile App with a SQL Database	This template provisions a Mobile App, SQL Database, and Notification Hub. It configures a connection string in the mobile app for the database and notification hub.
Provision a Web App with a SQL Database	This template provisions a Web App, a SQL Database, AutoScale settings, Alert rules, and App Insights. It configures a connection string in the web app for the database.
Provision Consumption plan function with a Deployment Slot	This template provisions a function app on a Consumption plan, which is a dynamic hosting plan. The app runs on demand and you're billed per execution, with no standing resource committment. There are other templates available for provisioning on a dedicated hosting plan.
PubNub Realtime Gateway for Azure Event Hubs	The PubNub Realtime Gateway for Azure provides a realtime data stream bridge between the PubNub Data Stream Network and Azure Event Hubs. -- consider it a bi-directional bridge between PubNub and Azure!
Scalable Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Secure N-tier Web App	This template allows you to create a secure end to end solution with two web apps with staging slots, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint
Simple Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Sonarqube Docker Web App on Linux with Azure SQL	This template deploys Sonarqube in an Azure App Service web app Linux container using the official Sonarqube image and backed by an Azure SQL Server.
Sonarqube Docker Web App on Linux with MySQL	This template provides a easy way to deploy a Sonarqube docker image (alpine tag) on a Linux Web App with Azure database for MySQL
Sonarqube Docker Web App on Linux with PostgreSQL	This template provides a easy way to deploy a Sonarqube docker image (alpine tag) on a Linux Web App with Azure database for PostgreSQL(Preview)
SonarQube on Web App with PostgreSQL and VNet integration	This template provides easy to deploy SonarQube to Web App on Linux with PostgreSQL Flexible Server, VNet integration and private DNS.
Web App Deployment from GitHub	This template allows you to create an WebApp linked with a GitHub Repository linked.
Web App on Linux with PostgreSQL	This template provides a easy way to deploy Web App on Linux with Azure database for PostgreSQL(Preview).
Web App on Linux with PostgreSQL	This template provides a easy way to deploy Web App on Linux with Azure database for PostgreSQL.
Web App w/ Application Insights sending to Log Analytics	This template will is to help support the new API versions of microsoft.insights/components. Starting with 2020-02-02-preview WorkspaceID will be required when creating Application Inisghts.This template will deploy the App Service Plan, App Service, Application Insights, Log Analytics Workspace and hook it all together.
Web App with a custom domain and optional SSL binding	Create a web app and with a custom domain and optionally add SSL certificate for https encryption.
Web App with a SQL Database, Azure Cosmos DB, Azure Search	This template provisions a Web App, a SQL Database, Azure Cosmos DB, Azure Search and Application Insights.
Web App with Azure database for MySQL	This template provides a easy way to deploy web app on Azure App Service Web Apps with Azure database for MySQL.
Web App with custom Deployment slots	This template provides an easy way to deploy a web app with custom deployment slots on Azure Web Apps.
Web App with diagnostics logging to Blob Container	Deploy a Web App with diagnostics logging to Storage Account Blob Container enabled.
Web App with Managed Identity, SQL Server and ΑΙ	Simple example to deploy Azure infrastructure for app + data + managed identity + monitoring
Web App with Private Endpoint	This template allows you to create a Web App and expose it through Private Endpoint
Web App with VNet Injection and Private Endpoint	This template allows you to create a secure end to end solution with two web apps, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint
WebApp consuming a Azure SQL Private Endpoint	This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server
WordPress on App Service with MySQL In App	This template deploys a WordPress Web App on a Windows App Service with MySQL in app

Terraform (AzAPI provider) resource definition

The serverfarms 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/serverfarms resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/serverfarms@2024-04-01"
  name = "string"
  extendedLocation = {
    name = "string"
  }
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      elasticScaleEnabled = bool
      freeOfferExpirationTime = "string"
      hostingEnvironmentProfile = {
        id = "string"
      }
      hyperV = bool
      isSpot = bool
      isXenon = bool
      kubeEnvironmentProfile = {
        id = "string"
      }
      maximumElasticWorkerCount = int
      perSiteScaling = bool
      reserved = bool
      spotExpirationTime = "string"
      targetWorkerCount = int
      targetWorkerSizeId = int
      workerTierName = "string"
      zoneRedundant = bool
    }
  })
  sku = {
    capabilities = [
      {
        name = "string"
        reason = "string"
        value = "string"
      }
    ]
    capacity = int
    family = "string"
    locations = [
      "string"
    ]
    name = "string"
    size = "string"
    skuCapacity = {
      default = int
      elasticMaximum = int
      maximum = int
      minimum = int
      scaleType = "string"
    }
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

Property values

AppServicePlanProperties

Name	Description	Value
elasticScaleEnabled	ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku	bool
freeOfferExpirationTime	The time when the server farm free offer expires.	string
hostingEnvironmentProfile	Specification for the App Service Environment to use for the App Service plan.	HostingEnvironmentProfile
hyperV	If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.	bool
isSpot	If <code>true</code>, this App Service Plan owns spot instances.	bool
isXenon	Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.	bool
kubeEnvironmentProfile	Specification for the Kubernetes Environment to use for the App Service plan.	KubeEnvironmentProfile
maximumElasticWorkerCount	Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan	int
perSiteScaling	If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan.	bool
reserved	If Linux app service plan <code>true</code>, <code>false</code> otherwise.	bool
spotExpirationTime	The time when the server farm expires. Valid only if it is a spot server farm.	string
targetWorkerCount	Scaling worker count.	int
targetWorkerSizeId	Scaling worker size ID.	int
workerTierName	Target worker tier assigned to the App Service plan.	string
zoneRedundant	If <code>true</code>, this App Service Plan will perform availability zone balancing. If <code>false</code>, this App Service Plan will not perform availability zone balancing.	bool

Capability

Name	Description	Value
name	Name of the SKU capability.	string
reason	Reason of the SKU capability.	string
value	Value of the SKU capability.	string

ExtendedLocation

Name	Description	Value
name	Name of extended location.	string

HostingEnvironmentProfile

Name	Description	Value
id	Resource ID of the App Service Environment.	string

KubeEnvironmentProfile

Name	Description	Value
id	Resource ID of the Kubernetes Environment.	string

Microsoft.Web/serverfarms

Name	Description	Value
extendedLocation	Extended Location.	ExtendedLocation
kind	Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.	string
location	Resource Location.	string (required)
name	The resource name	string (required)
properties	AppServicePlan resource specific properties	AppServicePlanProperties
sku	Description of a SKU for a scalable resource.	SkuDescription
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Web/serverfarms@2024-04-01"

ResourceTags

Name	Description	Value

SkuCapacity

Name	Description	Value
default	Default number of workers for this App Service plan SKU.	int
elasticMaximum	Maximum number of Elastic workers for this App Service plan SKU.	int
maximum	Maximum number of workers for this App Service plan SKU.	int
minimum	Minimum number of workers for this App Service plan SKU.	int
scaleType	Available scale configurations for an App Service plan.	string

SkuDescription

Name	Description	Value
capabilities	Capabilities of the SKU, e.g., is traffic manager enabled?	Capability[]
capacity	Current number of instances assigned to the resource.	int
family	Family code of the resource SKU.	string
locations	Locations of the SKU.	string[]
name	Name of the resource SKU.	string
size	Size specifier of the resource SKU.	string
skuCapacity	Min, max, and default scale values of the SKU.	SkuCapacity
tier	Service tier of the resource SKU.	string