Microsoft.Web sites/extensions 'MSDeploy' 2022-03-01
Bicep resource definition
The sites/extensions 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.
Options for name property
The sites/extensions resource accepts different properties based on the value of the name property.
This article shows the properties that are available when you set name: 'MSDeploy'.
For other options, see:
Resource format
To create a Microsoft.Web/sites/extensions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/sites/extensions@2022-03-01' = {
name: 'MSDeploy'
kind: 'string'
parent: resourceSymbolicName
properties: {
appOffline: bool
connectionString: 'string'
dbType: 'string'
packageUri: 'string'
setParameters: {}
setParametersXmlFileUri: 'string'
skipAppData: bool
}
}
Property values
sites/extensions-MSDeploy
| 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 destinationwill 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 |
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 |
This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps. |
| Simple Umbraco CMS Web App |
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 |
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 |
This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server |
| Moesif API Analytics and Monetization |
The template will log API calls from Azure API Management to Moesif API analytics and monetization platform |
| 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. |
| 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. |
| 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. |
| 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 |
ARM template resource definition
The sites/extensions 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.
Options for name property
The sites/extensions resource accepts different properties based on the value of the name property.
This article shows the properties that are available when you set name: 'MSDeploy'.
For other options, see:
Resource format
To create a Microsoft.Web/sites/extensions resource, add the following JSON to your template.
{
"type": "Microsoft.Web/sites/extensions",
"apiVersion": "2022-03-01",
"name": "MSDeploy",
"kind": "string",
"properties": {
"appOffline": "bool",
"connectionString": "string",
"dbType": "string",
"packageUri": "string",
"setParameters": {},
"setParametersXmlFileUri": "string",
"skipAppData": "bool"
}
}
Property values
sites/extensions-MSDeploy
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Web/sites/extensions' |
| apiVersion | The resource api version | '2022-03-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 destinationwill 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 |
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 |
This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps. |
| Simple Umbraco CMS Web App |
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 |
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 |
This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server |
| Moesif API Analytics and Monetization |
The template will log API calls from Azure API Management to Moesif API analytics and monetization platform |
| 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. |
| 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. |
| 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. |
| 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 |
Terraform (AzAPI provider) resource definition
The sites/extensions resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Options for name property
The sites/extensions resource accepts different properties based on the value of the name property.
This article shows the properties that are available when you set name: 'MSDeploy'.
For other options, see:
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/extensions@2022-03-01"
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-MSDeploy
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Web/sites/extensions@2022-03-01" |
| 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 destinationwill not be deleted, and any App_Data directory in the source will be ignored. Setting is false by default. |
bool |