Microsoft.Web sites/slots/extensions 2021-01-15

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.Web/sites/slots/extensions@2021-01-15' = {
  name: 'MSDeploy'
  kind: 'string'
  parent: resourceSymbolicName
  properties: {
    appOffline: bool
    connectionString: 'string'
    dbType: 'string'
    packageUri: 'string'
    setParameters: {}
    setParametersXmlFileUri: 'string'
    skipAppData: bool
  }
}

Property values

sites/slots/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: slots
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

ARM template resource definition

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

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

Property values

sites/slots/extensions

Name Description Value
type The resource type 'Microsoft.Web/sites/slots/extensions'
apiVersion The resource api version '2021-01-15'
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

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/slots/extensions@2021-01-15"
  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/slots/extensions

Name Description Value
type The resource type "Microsoft.Web/sites/slots/extensions@2021-01-15"
name The resource name "MSDeploy"
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: slots
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