Microsoft.Web/sites/extensions 2020-06-01 – Bicep, ARM template & Terraform AzAPI reference

Table of Contents0.1 In this article1 Bicep resource definition2 Resource format3 Property values3.1 sites/extensions3.2 MSDeployCoreOrMSDeployStatusProperties4 Quickstart templates5 ARM template resource definition6 Resource format7 Property values7.1 sites/extensions7.2 MSDeployCoreOrMSDeployStatusProperties8 Quickstart templates9 Terraform (AzAPI provider) resource definition10 Resource format11 Property values11.1 sites/extensions11.2 MSDeployCoreOrMSDeployStatusProperties Article 09/02/2022 5 minutes to […]

Bicep resource definition

The sites/extensions resource type can be deployed to:

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

Resource format

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

resource symbolicname 'Microsoft.Web/sites/[email protected]' = {
  name: 'MSDeploy'
  kind: 'string'
  parent: resourceSymbolicName
  properties: {
    appOffline: bool
    connectionString: 'string'
    dbType: 'string'
    packageUri: 'string'
    setParameters: {}
    setParametersXmlFileUri: 'string'
    skipAppData: bool
  }
}

Property values

sites/extensions

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.

‘MSDeploy’
kind Kind of resource. string
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.

Symbolic name for resource of type: sites
properties Core resource properties MSDeployCoreOrMSDeployStatusProperties

MSDeployCoreOrMSDeployStatusProperties

Name Description Value
appOffline Sets the AppOffline rule while the MSDeploy operation executes.
Setting is false by default.
bool
connectionString SQL Connection String string
dbType Database Type string
packageUri Package URI string
setParameters MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. object
setParametersXmlFileUri URI of MSDeploy Parameters file. Must not be set if SetParameters is used. string
skipAppData Controls whether the MSDeploy operation skips the App_Data directory.
If set to true, the existing App_Data directory on the destination
will not be deleted, and any App_Data directory in the source will be ignored.
Setting is false by default.
bool

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Orchard CMS Video Portal Web App

Deploy to Azure

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.
Scalable Umbraco CMS Web App

Deploy to Azure

This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Simple Umbraco CMS Web App

Deploy to Azure

This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Enterprise Governance-AppService, SQL DB, AD, OMS, Runbooks

Deploy to Azure

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.
WebApp consuming a Azure SQL Private Endpoint

Deploy to Azure

This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server
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

ARM template resource definition

The sites/extensions resource type can be deployed to:

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

Resource format

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

{
  "type": "Microsoft.Web/sites/extensions",
  "apiVersion": "2020-06-01",
  "name": "MSDeploy",
  "kind": "string",
  "properties": {
    "appOffline": "bool",
    "connectionString": "string",
    "dbType": "string",
    "packageUri": "string",
    "setParameters": {},
    "setParametersXmlFileUri": "string",
    "skipAppData": "bool"
  }
}

Property values

sites/extensions

Name Description Value
type The resource type ‘Microsoft.Web/sites/extensions’
apiVersion The resource api version ‘2020-06-01’
name The resource name

See how to set names and types for child resources in JSON ARM templates.

‘MSDeploy’
kind Kind of resource. string
properties Core resource properties MSDeployCoreOrMSDeployStatusProperties

MSDeployCoreOrMSDeployStatusProperties

Name Description Value
appOffline Sets the AppOffline rule while the MSDeploy operation executes.
Setting is false by default.
bool
connectionString SQL Connection String string
dbType Database Type string
packageUri Package URI string
setParameters MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. object
setParametersXmlFileUri URI of MSDeploy Parameters file. Must not be set if SetParameters is used. string
skipAppData Controls whether the MSDeploy operation skips the App_Data directory.
If set to true, the existing App_Data directory on the destination
will not be deleted, and any App_Data directory in the source will be ignored.
Setting is false by default.
bool

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Orchard CMS Video Portal Web App

Deploy to Azure

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.
Scalable Umbraco CMS Web App

Deploy to Azure

This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Simple Umbraco CMS Web App

Deploy to Azure

This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Enterprise Governance-AppService, SQL DB, AD, OMS, Runbooks

Deploy to Azure

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.
WebApp consuming a Azure SQL Private Endpoint

Deploy to Azure

This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server
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

Terraform (AzAPI provider) resource definition

The sites/extensions resource type can be deployed to:

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/[email protected]"
  name = "MSDeploy"
  parent_id = "string"
  body = jsonencode({
    properties = {
      appOffline = bool
      connectionString = "string"
      dbType = "string"
      packageUri = "string"
      setParameters = {}
      setParametersXmlFileUri = "string"
      skipAppData = bool
    }
    kind = "string"
  })
}

Property values

sites/extensions

Name Description Value
type The resource type “Microsoft.Web/sites/[email protected]
name The resource name “MSDeploy”
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites
kind Kind of resource. string
properties Core resource properties MSDeployCoreOrMSDeployStatusProperties

MSDeployCoreOrMSDeployStatusProperties

Name Description Value
appOffline Sets the AppOffline rule while the MSDeploy operation executes.
Setting is false by default.
bool
connectionString SQL Connection String string
dbType Database Type string
packageUri Package URI string
setParameters MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. object
setParametersXmlFileUri URI of MSDeploy Parameters file. Must not be set if SetParameters is used. string
skipAppData Controls whether the MSDeploy operation skips the App_Data directory.
If set to true, the existing App_Data directory on the destination
will not be deleted, and any App_Data directory in the source will be ignored.
Setting is false by default.
bool

Source Article

Next Post

Microsoft.Web/sites/config 'pushsettings' 2022-03-01 - Bicep, ARM template & Terraform AzAPI reference

Wed Sep 28 , 2022
Airflow Web App with PostgreSQL database on App Services A template for deploying Airflow Web App with PostgreSQL database on App Services EPiserverCMS in Azure This template allows you to create resources required for EpiServerCMS deployment in Azure Java CI/CD using Jenkins and Azure Web Apps This is a sample […]