Share via

Microsoft.Web sites/instances/extensions 2024-04-01

  • Article

Bicep resource definition

The sites/instances/extensions resource type can be deployed with operations that target:

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

Resource format

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

resource symbolicname 'Microsoft.Web/sites/instances/extensions@2024-04-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/instances/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/instances
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

ARM template resource definition

The sites/instances/extensions resource type can be deployed with operations that target:

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

Resource format

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

{
  "type": "Microsoft.Web/sites/instances/extensions",
  "apiVersion": "2024-04-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/instances/extensions

Name Description Value
apiVersion The api version '2024-04-01'
kind Kind of resource. string
name The resource name 'MSDeploy' (required)
properties Core resource properties MSDeployCoreOrMSDeployStatusProperties
type The resource type 'Microsoft.Web/sites/instances/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

Terraform (AzAPI provider) resource definition

The sites/instances/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/instances/extensions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/instances/extensions@2024-04-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/instances/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/instances
properties Core resource properties MSDeployCoreOrMSDeployStatusProperties
type The resource type "Microsoft.Web/sites/instances/extensions@2024-04-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