Microsoft.Web sites/extensions 2019-08-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.
Resource format
To create a Microsoft.Web/sites/extensions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/sites/extensions@2019-08-01' = {
kind: 'string'
name: 'MSDeploy'
properties: {
appOffline: bool
connectionString: 'string'
dbType: 'string'
packageUri: 'string'
setParameters: {
{customized property}: 'string'
}
setParametersXmlFileUri: 'string'
skipAppData: bool
}
}
Property values
Microsoft.Web/sites/extensions
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| name | The resource name | 'MSDeploy' (required) |
| 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 <code>false</code> 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. | MSDeployCoreSetParameters |
| 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 <code>true</code>, 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 <code>false</code> by default. |
bool |
MSDeployCoreSetParameters
| Name | Description | Value |
|---|
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Moesif API Analytics and Monetization | The template will log API calls from Azure API Management to Moesif API analytics and monetization platform |
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.
Resource format
To create a Microsoft.Web/sites/extensions resource, add the following JSON to your template.
{
"type": "Microsoft.Web/sites/extensions",
"apiVersion": "2019-08-01",
"name": "string",
"kind": "string",
"properties": {
"appOffline": "bool",
"connectionString": "string",
"dbType": "string",
"packageUri": "string",
"setParameters": {
"{customized property}": "string"
},
"setParametersXmlFileUri": "string",
"skipAppData": "bool"
}
}
Property values
Microsoft.Web/sites/extensions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2019-08-01' |
| kind | Kind of resource. | string |
| name | The resource name | 'MSDeploy' (required) |
| properties | Core resource properties | MSDeployCoreOrMSDeployStatusProperties |
| type | The resource type | 'Microsoft.Web/sites/extensions' |
MSDeployCoreOrMSDeployStatusProperties
| Name | Description | Value |
|---|---|---|
| appOffline | Sets the AppOffline rule while the MSDeploy operation executes. Setting is <code>false</code> 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. | MSDeployCoreSetParameters |
| 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 <code>true</code>, 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 <code>false</code> by default. |
bool |
MSDeployCoreSetParameters
| Name | Description | Value |
|---|
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
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. |
| 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. |
| 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. |
| Moesif API Analytics and Monetization |
The template will log API calls from Azure API Management to Moesif API analytics and monetization platform |
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.
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@2019-08-01"
name = "string"
kind = "string"
body = jsonencode({
properties = {
appOffline = bool
connectionString = "string"
dbType = "string"
packageUri = "string"
setParameters = {
{customized property} = "string"
}
setParametersXmlFileUri = "string"
skipAppData = bool
}
})
}
Property values
Microsoft.Web/sites/extensions
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| name | The resource name | 'MSDeploy' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: sites |
| properties | Core resource properties | MSDeployCoreOrMSDeployStatusProperties |
| type | The resource type | "Microsoft.Web/sites/extensions@2019-08-01" |
MSDeployCoreOrMSDeployStatusProperties
| Name | Description | Value |
|---|---|---|
| appOffline | Sets the AppOffline rule while the MSDeploy operation executes. Setting is <code>false</code> 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. | MSDeployCoreSetParameters |
| 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 <code>true</code>, 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 <code>false</code> by default. |
bool |
MSDeployCoreSetParameters
| Name | Description | Value |
|---|