Top / Microsoft Azure / Azure App Service (Web Apps) / Service Plan

Azure App Service (Web Apps) Service Plan

This page shows how to write Terraform and Azure Resource Manager for App Service (Web Apps) Service Plan and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_service_plan (Terraform)

The Service Plan in App Service (Web Apps) can be configured in Terraform with the resource name azurerm_service_plan. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • name - (Required) The name which should be used for this Service Plan. Changing this forces a new AppService to be created.

  • location - (Required) The Azure Region where the Service Plan should exist. Changing this forces a new AppService to be created.

  • os_type - (Required) The O/S type for the App Services to be hosted in this plan. Possible values include Windows, Linux, and WindowsContainer.

  • resource_group_name - (Required) The name of the Resource Group where the AppService should exist. Changing this forces a new AppService to be created.

  • sku_name - (Required) The SKU for the plan. Possible values include B1, B2, B3, D1, F1, FREE, I1, I2, I3, I1v2, I2v2, I3v2, P1v2, P2v2, P3v2, P1v3, P2v3, P3v3, S1, S2, S3, SHARED, PC2, PC3, PC4, EP1, EP2, EP3, WS1, WS2, and WS3,.

NOTE: Isolated SKUs (I1, I2, I3, I1v2, I2v2, and I3v2) can only be used with App Service Environments

NOTE: Elastic and Consumption SKUs (PC2, PC3, PC4, EP1, EP2, and EP3) are for use with Function Apps.

  • app_service_environment_id - (Optional) The ID of the App Service Environment to create this Service Plan in.

NOTE: Requires an Isolated SKU. Use one of I1, I2, I3 for azurerm_app_service_environment, or I1v2, I2v2, I3v2 for azurerm_app_service_environment_v3

  • maximum_elastic_worker_count - (Optional) The maximum number of workers to use in an Elastic SKU Plan. Cannot be set unless using an Elastic SKU.

  • number_of_workers - (Optional) The number of Workers (instances) to be allocated.

  • per_site_scaling_enabled - (Optional) Should Per Site Scaling be enabled. Defaults to false.

  • tags - (Optional) A mapping of tags which should be assigned to the AppService.

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the Service Plan.

  • kind - A string representing the Kind of Service Plan.

  • reserved - Whether this is a reserved Service Plan Type. true if os_type is Linux, otherwise false.

>> from Terraform Registry

Explanation in Terraform Registry

Manages an App Service: Service Plan. !> Note: This Resource is coming in version 3.0 of the Azure Provider and is available as an opt-in Beta - more information can be found in the upcoming version 3.0 of the Azure Provider.

>> from Terraform Registry

Tips: Best Practices for The Other Azure App Service (Web Apps) Resources

In addition to the azurerm_app_service, Azure App Service (Web Apps) has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.

risk-label

azurerm_app_service

Ensure your App Service is accessible via HTTPS only

It is better to configure the App Service to be accessible via HTTPS only. By default, both HTTP and HTTPS are available.

risk-label

azurerm_function_app

Ensure to enable authentication to prevent anonymous request being accepted

It is better to enable authentication to prevent anonymous requests and ensure all communications in the application are authenticated.

Review your Azure App Service (Web Apps) settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

Microsoft.Web/serverfarms (Azure Resource Manager)

The serverfarms in Microsoft.Web can be configured in Azure Resource Manager with the resource name Microsoft.Web/serverfarms. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

AppServiceConfig.json#L4
            "resourceType": "Microsoft.Web/serverfarms",
            "sku": {
                "name": "F1",
                "tier": "Free"
            },
            "capacity": {
AppServiceConfig.json#L4
            "resourceType": "Microsoft.Web/serverfarms",
            "sku": {
                "name": "F1",
                "tier": "Free"
            },
            "capacity": {
AppServicePlanTemplate.json#L84
            "type": "Microsoft.Web/serverfarms",
            "location": "[parameters('aseLocation')]",
            "properties": {
                "name": "[parameters('CMappServicePlanName')]",
                "hostingEnvironmentProfile": {
                     "id": "[resourceId('Microsoft.Web/hostingEnvironments',parameters('appServiceEnvironmentName'))]"
w0.json#L50
            "type": "Microsoft.Web/serverfarms",
            "apiVersion": "2018-02-01",
            "name": "[parameters('serverfarms_chieuannhieusd001_name')]",
            "location": "West US",
            "sku": {
                "name": "P3v2",
e7.json#L50
            "type": "Microsoft.Web/serverfarms",
            "apiVersion": "2018-02-01",
            "name": "[parameters('serverfarms_chieuannhieusd071_name')]",
            "location": "East US",
            "sku": {
                "name": "P3v2",
e9.json#L50
            "type": "Microsoft.Web/serverfarms",
            "apiVersion": "2018-02-01",
            "name": "[parameters('serverfarms_chieuannhieusd091_name')]",
            "location": "East US",
            "sku": {
                "name": "P3v2",
e6.json#L50
            "type": "Microsoft.Web/serverfarms",
            "apiVersion": "2018-02-01",
            "name": "[parameters('serverfarms_chieuannhieusd061_name')]",
            "location": "East US",
            "sku": {
                "name": "P3v2",
e27.json#L50
            "type": "Microsoft.Web/serverfarms",
            "apiVersion": "2018-02-01",
            "name": "[parameters('serverfarms_chieuannhieusd071_name')]",
            "location": "East US 2",
            "sku": {
                "name": "P3v2",
w27.json#L50
            "type": "Microsoft.Web/serverfarms",
            "apiVersion": "2018-02-01",
            "name": "[parameters('serverfarms_chieuannhieusd071_name')]",
            "location": "West US 2",
            "sku": {
                "name": "P3v2",
w1.json#L50
            "type": "Microsoft.Web/serverfarms",
            "apiVersion": "2018-02-01",
            "name": "[parameters('serverfarms_chieuannhieusd011_name')]",
            "location": "West US",
            "sku": {
                "name": "P3v2",

Parameters

  • apiVersion required - string
  • extendedLocation optional
      • name optional - string

        Name of extended location.

  • kind optional - string

    Kind of resource.

  • location required - string

    Resource Location.

  • name required - string

    Name of the App Service plan.

  • properties required
      • elasticScaleEnabled optional - boolean

        ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku

      • freeOfferExpirationTime optional - string

        The time when the server farm free offer expires.

      • hostingEnvironmentProfile optional
          • id optional - string

            Resource ID of the App Service Environment.

      • hyperV optional - boolean

        If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.

      • isSpot optional - boolean

        If <code>true</code>, this App Service Plan owns spot instances.

      • isXenon optional - boolean

        Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.

      • kubeEnvironmentProfile optional
          • id optional - string

            Resource ID of the Kubernetes Environment.

      • maximumElasticWorkerCount optional - integer

        Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

      • perSiteScaling optional - boolean

        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.

      • reserved optional - boolean

        If Linux app service plan <code>true</code>, <code>false</code> otherwise.

      • spotExpirationTime optional - string

        The time when the server farm expires. Valid only if it is a spot server farm.

      • targetWorkerCount optional - integer

        Scaling worker count.

      • targetWorkerSizeId optional - integer

        Scaling worker size ID.

      • workerTierName optional - string

        Target worker tier assigned to the App Service plan.

      • zoneRedundant optional - boolean

        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.

  • sku optional
      • capabilities optional array
          • name optional - string

            Name of the SKU capability.

          • reason optional - string

            Reason of the SKU capability.

          • value optional - string

            Value of the SKU capability.

      • capacity optional - integer

        Current number of instances assigned to the resource.

      • family optional - string

        Family code of the resource SKU.

      • locations optional - array

        Locations of the SKU.

      • name optional - string

        Name of the resource SKU.

      • size optional - string

        Size specifier of the resource SKU.

      • skuCapacity optional
          • default optional - integer

            Default number of workers for this App Service plan SKU.

          • elasticMaximum optional - integer

            Maximum number of Elastic workers for this App Service plan SKU.

          • maximum optional - integer

            Maximum number of workers for this App Service plan SKU.

          • minimum optional - integer

            Minimum number of workers for this App Service plan SKU.

          • scaleType optional - string

            Available scale configurations for an App Service plan.

      • tier optional - string

        Service tier of the resource SKU.

  • tags optional - string

    Resource tags.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure App Service (Web Apps) Resources

Frequently asked questions

What is Azure App Service (Web Apps) Service Plan?

Azure App Service (Web Apps) Service Plan is a resource for App Service (Web Apps) of Microsoft Azure. Settings can be wrote in Terraform.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents