Back to Azure Resource templates index <–
Azure API App deployment in an existing Azure App Service Plan.
Template Locations
Infrastructure As Code Advisor (Beta)
WAF-compliance
The WAF-compliance advisor validates templates based on the Well Architected Framework practices. Every day a GitHub Action updates the templates compliance data and lists the recomendations.
Sustainbility Advisor
The sustainability advisor is based on the Sogeti Cloud Reference Architecture with sustainble practices. These sustainble practices cover application code, cloud infrastructures and data. The global Sogeti community is continously evolving the sustainble practices and every day new and tuned are added. For cloud infrastructures the sustainble practices are automatically validated and reported below.
note: when 100% it can be that there is no sustainble practices yet for this Cloud infrastructure.
Online documentation
Template reference
Service description
Related Azure Resources
| Resource | Description | Automation |
|---|---|---|
| Azure API Management | This set of templates helps automating the provisioning of Azure API Management. | ARM |
| Application Insights | his template creates an Application Insights object, but doesn't connect it with any resource yet.. | ARM |
| App Service Plan | Azure App Service plan deployment creates an Azure App Service Plan and configures the initial Scale Out options. | ARM |
| App Service Plan Linux | Azure App Service plan deployment creates an Azure App Service Plan using Linux Operating System. | ARM |
| App Service Plan Windows | Azure App Service plan deployment creates an Azure App Service Plan and configures the initial Scale Out options. This version is based on the Linux operating system. | Bicep |
| App Service Plan Windows | Azure App Service plan deployment creates an Azure App Service Plan and configures the initial Scale Out options. | Bicep |
Related Pipelines
| Resource | Description | Type |
|---|---|---|
| Azure API Management Products and subscriptions | Configure the Azure API Management products and subscriptions. | |
| Azure API Management release pipeline create the service | Provision an Azure API Management service. | |
| Azure API Management Users and Groups | Configure the Azure API Management users and groups. |
Used by Landing zone(s)
| Landing zone name |
|---|
| Azure API Management |
Requirements
- Resource group must been created with a valid name and location.
- App Service Plan must be created in a know resource group.
- Only one API App Service per resource group
Input values
- tagBillingIdentifier: Cost Center.
- aspName : Name of existing App Service Plan.
- aspResourceGroup: Resourcegroup Location of the existing App Service Plan.
Output values
- ApiAppPrincipalId: The identity of the API App service in the current Azure Active Directory.
Additional information
An Azure Web app resource is never alone. It will always need an App Service Plan and an Application Insights component, and most often also with an Azure KeyVault for the connection strings, other secrets and certificates.
The template contains the basic settings for an Azure Web App, only the billing tag and the resource group needs to be specified. Specific configuration needs can be set with the Azure CLI WebApp configuration. For example add application settings:
az webapp config appsettings set -g resourcegroup -n webappname --settings settingname=settingvalue
All other settings can follow the same commands.
For an example release see: Cloudification Web App Azure DevOps release
See template for Azure Resource Manager template.
Compliance Advisor details
Resource Health Result
| Message | ResourceType | Severity |
|---|---|---|
| It is recommended to use below property for your resource Microsoft.Web/sites{ "minTlsVersion": "1.2" }TLS should be updated to the latest version for you web app | Microsoft.Web/sites | 3 |
| It is recommended to use below property for your resource Microsoft.Web/sites{ "ftpsState": "Disabled" }If DevOps is used for Deployment then Ftps should be disabled, else Ftps can be used for Deployment. So ftpsState can be 'AllAllowed', 'FtpsOnly' or 'Disabled | Microsoft.Web/sites | 3 |
| It is recommended to use below property for your resource Microsoft.Web/sites { "httpsOnly": true }Application or Functions should be only be accessible over HTTPS | Microsoft.Web/sites | 2 |
| Location for the resource should not be hardcoded, it should be parameterized and should refer from Resource Group's location i.e. [resourceGroup().location] | Microsoft.Web/sites | 2 |
| It is recommended to enable slots for your App service for non production environment, which will eliminate the need of having multiple hardware allocation for different environment | Microsoft.Web/sites | 2 |
| Consider using a CDN to distribute your application's static assets closer to the source of a request. This distrubution of assets reduces the distance all request for static assets has to travel over the network' | Microsoft.Web/sites | 2 |
| Your current API Version i.e.2019-08-01 for the resource Microsoft.Web/sites is outdatedconsider updating to new recent version available i.e. 2022-09-01 or 2022-03-01 | Microsoft.Web/sites | 2 |
| To help other contributors understand the purpose of the resource, specify comments for each resource in the template | Microsoft.Web/sites | 1 |
| It is recommended to parameterized your tag and make it as object type | Microsoft.Web/sites | 1 |
TemplateParameterHealthResult
| Message | Severity |
|---|---|
| It is recommended to make your parameter as camel case, wherever possible for i.e. webappcustomnameRead More | 1 |
| Define default values for parameters that aren't sensitive. By specifying a default value, it's easier to deploy the template, and users of your template see an example of an appropriate value i.e. webappcustomnameRead More | 1 |
TemplateVariableHealthResult
| Message | Severity |
|---|---|
| It is recommended to make your variable as camel case, wherever possible for e.g. environmentRead More | 1 |
Sustainable Advisor details
| Message | ResourceType | Severity |
|---|---|---|
| It is recommended to enable slots for your App service for non production environment, which will eliminate the need of having multiple hardware allocation for different environment | Microsoft.Web/sites | 2 |
| Consider using a CDN to distribute your application's static assets closer to the source of a request. This distrubution of assets reduces the distance all request for static assets has to travel over the network' | Microsoft.Web/sites | 2 |