Microsoft.Web serverfarms 2020-12-01

Template format

To create a Microsoft.Web/serverfarms resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Web/serverfarms",
  "apiVersion": "2020-12-01",
  "kind": "string",
  "location": "string",
  "tags": {},
  "properties": {
    "workerTierName": "string",
    "hostingEnvironmentProfile": {
      "id": "string"
    },
    "perSiteScaling": "boolean",
    "maximumElasticWorkerCount": "integer",
    "isSpot": "boolean",
    "spotExpirationTime": "string",
    "freeOfferExpirationTime": "string",
    "reserved": "boolean",
    "isXenon": "boolean",
    "hyperV": "boolean",
    "targetWorkerCount": "integer",
    "targetWorkerSizeId": "integer",
    "kubeEnvironmentProfile": {
      "id": "string"
    }
  },
  "sku": {
    "name": "string",
    "tier": "string",
    "size": "string",
    "family": "string",
    "capacity": "integer",
    "skuCapacity": {
      "minimum": "integer",
      "maximum": "integer",
      "elasticMaximum": "integer",
      "default": "integer",
      "scaleType": "string"
    },
    "locations": [
      "string"
    ],
    "capabilities": [
      {
        "name": "string",
        "value": "string",
        "reason": "string"
      }
    ]
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Web/serverfarms object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Name of the App Service plan.
type enum Yes For JSON - Microsoft.Web/serverfarms
apiVersion enum Yes For JSON - 2020-12-01
kind string No Kind of resource.
location string Yes Resource Location.
tags object No Resource tags.
properties object Yes AppServicePlan resource specific properties - AppServicePlanProperties object
sku object No SkuDescription object

AppServicePlanProperties object

Name Type Required Value
workerTierName string No Target worker tier assigned to the App Service plan.
hostingEnvironmentProfile object No Specification for the App Service Environment to use for the App Service plan. - HostingEnvironmentProfile object
perSiteScaling boolean No If true, apps assigned to this App Service plan can be scaled independently.If false, apps assigned to this App Service plan will scale to all instances of the plan.
maximumElasticWorkerCount integer No Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
isSpot boolean No If true, this App Service Plan owns spot instances.
spotExpirationTime string No The time when the server farm expires. Valid only if it is a spot server farm.
freeOfferExpirationTime string No The time when the server farm free offer expires.
reserved boolean No If Linux app service plan true, false otherwise.
isXenon boolean No Obsolete: If Hyper-V container app service plan true, false otherwise.
hyperV boolean No If Hyper-V container app service plan true, false otherwise.
targetWorkerCount integer No Scaling worker count.
targetWorkerSizeId integer No Scaling worker size ID.
kubeEnvironmentProfile object No Specification for the Kubernetes Environment to use for the App Service plan. - KubeEnvironmentProfile object

SkuDescription object

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

HostingEnvironmentProfile object

Name Type Required Value
id string No Resource ID of the App Service Environment.

KubeEnvironmentProfile object

Name Type Required Value
id string No Resource ID of the Kubernetes Environment.

SkuCapacity object

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

Capability object

Name Type Required Value
name string No Name of the SKU capability.
value string No Value of the SKU capability.
reason string No Reason of the SKU capability.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Empty Function App

Deploy to Azure
This template deploy an empty Function App and a hosting plan.
App Service Quickstart - Linux App

Deploy to Azure
This template is to be used with https://docs.microsoft.com/azure/app-service/quickstart-arm-template
App Service Quickstart - Windows app

Deploy to Azure
This template is to be used with https://docs.microsoft.com/azure/app-service/quickstart-arm-template
Deploy an app service with regional VNet integration

Deploy to Azure
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
App Service Environment with Azure SQL backend

Deploy to Azure
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

Deploy to Azure
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.

Deploy to Azure
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
Azure Cosmos DB Account with Web App

Deploy to Azure
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.
Provision a function app on a dedicated hosting plan

Deploy to Azure
This template provisions a function app on a dedicated hosting plan, meaning it will be run and billed just like any App Service site. There are other templates available for provisioning on a dynamic hosting plan.
Provision a function app on a Consumption plan

Deploy to Azure
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 Consumption plan function with a Deployment Slot

Deploy to Azure
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 with source deployed from GitHub

Deploy to Azure
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.
Create Function App and private endpoint-secured Storage

Deploy to Azure
This template allows you to deploy an Azure Function App that communicates with Azure Storage over private endpoints.
Deploy an Azure Function Premium plan with vnet integration

Deploy to Azure
This template allows you to deploy an Azure Function Premium plan with regional virtual network integration enabled to a newly created virtual network.
Creates a function app with managed service identity.

Deploy to Azure
Creates a function app with managed service identity enabled with Application Insights set up for logs and metrics.
Provision a Mobile App with a SQL Database

Deploy to Azure
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.
Web App with Private Endpoint

Deploy to Azure
This template allows you to create a Web App and expose it through Private Endpoint
Create an AppServicePlan and App in an ASE

Deploy to Azure
Create an AppServicePlan and App in an ASE
Create an AppServicePlan and App in an App. Service Env. v2

Deploy to Azure
Create an AppServicePlan and App in an App Service Environment v2
Create Azure Web app with Blob Storage connection string

Deploy to Azure
Creates an Azure Web app with Blob Storage connection string, Template originally authored by Jeff Bowles of Microsoft
Web App with a custom domain and optional SSL binding

Deploy to Azure
Create a web app and with a custom domain and optionally add SSL certificate for https encryption.
Web App with diagnostics logging to Blob Container

Deploy to Azure
Deploy a Web App with diagnostics logging to Storage Account Blob Container enabled.
WebApp GitHub

Deploy to Azure
This template allows you to create an WebApp linked with a GitHub Repository linked.
Create a web app on Azure with Java 13 and Tomcat 9 enabled

Deploy to Azure
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.
Web App w/ Application Insights sending to Log Analytics

Deploy to Azure
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.
Create a web app on Azure with Python enabled

Deploy to Azure
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 + Redis Cache + SQL DB with a template

Deploy to Azure
This template creates an Azure Web App with Redis cache and a SQL Database.
Provision a Web App with a SQL Database

Deploy to Azure
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.
Create a Web App protected by Application Gateway v2

Deploy to Azure
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 plus Redis Cache using a template

Deploy to Azure
This template creates an Azure Web App with Redis cache.
Deploy a basic Linux web app

Deploy to Azure
This template allows you to deploy an app service plan and a basic Linux web app
App Service Quickstart - Windows app

Deploy to Azure
This template is to be used with https://docs.microsoft.com/azure/app-service/quickstart-arm-template
Web App with custom Deployment slots

Deploy to Azure
This template provides an easy way to deploy a web app with custom deployment slots on Azure Web Apps.
Airflow Docker Web App on Linux with PostgreSQL

Deploy to Azure
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
Django app

Deploy to Azure
This template allows you to create an App Service for deploying a Django app.
Flask app service

Deploy to Azure
This template allows you to create an App Service for deploying a Flask app.
Web App on Linux with Azure database for MySQL

Deploy to Azure
This template provides a way to deploy Web Apps on Linux with Azure database for MySQL.
Web App on Linux with PostgreSQL

Deploy to Azure
This template provides a easy way to deploy Web App on Linux with Azure database for PostgreSQL(Preview).
Node App Service

Deploy to Azure
This template allows you to create an App Service for deploying a Node app.
Sonarqube Docker Web App on Linux with Azure SQL

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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)
Web App with Azure database for MySQL

Deploy to Azure
This template provides a easy way to deploy web app on Azure App Service Web Apps with Azure database for MySQL.
Web App on Linux with PostgreSQL

Deploy to Azure
This template provides a easy way to deploy Web App on Linux with Azure database for PostgreSQL.
Web App with VNet Injection and Private Endpoint.

Deploy to Azure
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
ASP.NET app

Deploy to Azure
This template allows you to create an App Service for deploying a ASP.NET app.