Microsoft.Web sites/slots 2016-08-01

• Latest
• 2024-04-01
• 2023-12-01
• 2023-01-01
• 2022-09-01
• 2022-03-01
• 2021-03-01
• 2021-02-01
• 2021-01-15
• 2021-01-01
• 2020-12-01
• 2020-10-01
• 2020-09-01
• 2020-06-01
• 2019-08-01
• 2018-11-01
• 2018-02-01
• 2016-08-01
• 2015-08-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Web/sites/slots@2016-08-01' = {
  identity: {
    type: 'string'
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    clientAffinityEnabled: bool
    clientCertEnabled: bool
    cloningInfo: {
      appSettingsOverrides: {
        {customized property}: 'string'
      }
      cloneCustomHostNames: bool
      cloneSourceControl: bool
      configureLoadBalancing: bool
      correlationId: 'string'
      hostingEnvironment: 'string'
      ignoreQuotas: bool
      overwrite: bool
      sourceWebAppId: 'string'
      trafficManagerProfileId: 'string'
      trafficManagerProfileName: 'string'
    }
    containerSize: int
    dailyMemoryTimeQuota: int
    enabled: bool
    hostingEnvironmentProfile: {
      id: 'string'
    }
    hostNamesDisabled: bool
    hostNameSslStates: [
      {
        hostType: 'string'
        name: 'string'
        sslState: 'string'
        thumbprint: 'string'
        toUpdate: bool
        virtualIP: 'string'
      }
    ]
    httpsOnly: bool
    reserved: bool
    scmSiteAlsoStopped: bool
    serverFarmId: 'string'
    siteConfig: {
      alwaysOn: bool
      apiDefinition: {
        url: 'string'
      }
      appCommandLine: 'string'
      appSettings: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      autoHealEnabled: bool
      autoHealRules: {
        actions: {
          actionType: 'string'
          customAction: {
            exe: 'string'
            parameters: 'string'
          }
          minProcessExecutionTime: 'string'
        }
        triggers: {
          privateBytesInKB: int
          requests: {
            count: int
            timeInterval: 'string'
          }
          slowRequests: {
            count: int
            timeInterval: 'string'
            timeTaken: 'string'
          }
          statusCodes: [
            {
              count: int
              status: int
              subStatus: int
              timeInterval: 'string'
              win32Status: int
            }
          ]
        }
      }
      autoSwapSlotName: 'string'
      connectionStrings: [
        {
          connectionString: 'string'
          name: 'string'
          type: 'string'
        }
      ]
      cors: {
        allowedOrigins: [
          'string'
        ]
      }
      defaultDocuments: [
        'string'
      ]
      detailedErrorLoggingEnabled: bool
      documentRoot: 'string'
      experiments: {
        rampUpRules: [
          {
            actionHostName: 'string'
            changeDecisionCallbackUrl: 'string'
            changeIntervalInMinutes: int
            changeStep: int
            maxReroutePercentage: int
            minReroutePercentage: int
            name: 'string'
            reroutePercentage: int
          }
        ]
      }
      handlerMappings: [
        {
          arguments: 'string'
          extension: 'string'
          scriptProcessor: 'string'
        }
      ]
      http20Enabled: bool
      httpLoggingEnabled: bool
      ipSecurityRestrictions: [
        {
          ipAddress: 'string'
          subnetMask: 'string'
        }
      ]
      javaContainer: 'string'
      javaContainerVersion: 'string'
      javaVersion: 'string'
      limits: {
        maxDiskSizeInMb: int
        maxMemoryInMb: int
        maxPercentageCpu: int
      }
      linuxFxVersion: 'string'
      loadBalancing: 'string'
      localMySqlEnabled: bool
      logsDirectorySizeLimit: int
      managedPipelineMode: 'string'
      minTlsVersion: 'string'
      netFrameworkVersion: 'string'
      nodeVersion: 'string'
      numberOfWorkers: int
      phpVersion: 'string'
      publishingUsername: 'string'
      push: {
        kind: 'string'
        properties: {
          dynamicTagsJson: 'string'
          isPushEnabled: bool
          tagsRequiringAuth: 'string'
          tagWhitelistJson: 'string'
        }
      }
      pythonVersion: 'string'
      remoteDebuggingEnabled: bool
      remoteDebuggingVersion: 'string'
      requestTracingEnabled: bool
      requestTracingExpirationTime: 'string'
      scmType: 'string'
      tracingOptions: 'string'
      use32BitWorkerProcess: bool
      virtualApplications: [
        {
          physicalPath: 'string'
          preloadEnabled: bool
          virtualDirectories: [
            {
              physicalPath: 'string'
              virtualPath: 'string'
            }
          ]
          virtualPath: 'string'
        }
      ]
      vnetName: 'string'
      webSocketsEnabled: bool
    }
    snapshotInfo: {
      kind: 'string'
      properties: {
        ignoreConflictingHostNames: bool
        overwrite: bool
        recoverConfiguration: bool
        recoveryTarget: {
          id: 'string'
          location: 'string'
        }
        snapshotTime: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

ApiDefinitionInfo

Name	Description	Value
url	The URL of the API definition.	string

AutoHealActions

Name	Description	Value
actionType	Predefined action to be taken.	'CustomAction' 'LogEvent' 'Recycle'
customAction	Custom action to be taken.	AutoHealCustomAction
minProcessExecutionTime	Minimum time the process must execute before taking the action	string

AutoHealCustomAction

Name	Description	Value
exe	Executable to be run.	string
parameters	Parameters for the executable.	string

AutoHealRules

Name	Description	Value
actions	Actions to be executed when a rule is triggered.	AutoHealActions
triggers	Conditions that describe when to execute the auto-heal actions.	AutoHealTriggers

AutoHealTriggers

Name	Description	Value
privateBytesInKB	A rule based on private bytes.	int
requests	A rule based on total requests.	RequestsBasedTrigger
slowRequests	A rule based on request execution time.	SlowRequestsBasedTrigger
statusCodes	A rule based on status codes.	StatusCodesBasedTrigger[]

CloningInfo

Name	Description	Value
appSettingsOverrides	Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.	CloningInfoAppSettingsOverrides
cloneCustomHostNames	<code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.	bool
cloneSourceControl	<code>true</code> to clone source control from source app; otherwise, <code>false</code>.	bool
configureLoadBalancing	<code>true</code> to configure load balancing for source and destination app.	bool
correlationId	Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.	string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
hostingEnvironment	App Service Environment.	string
ignoreQuotas	<code>true</code> if quotas should be ignored; otherwise, <code>false</code>.	bool
overwrite	<code>true</code> to overwrite destination app; otherwise, <code>false</code>.	bool
sourceWebAppId	ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.	string (required)
trafficManagerProfileId	ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.	string
trafficManagerProfileName	Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.	string

CloningInfoAppSettingsOverrides

Name	Description	Value

ConnStringInfo

Name	Description	Value
connectionString	Connection string value.	string
name	Name of connection string.	string
type	Type of database.	'ApiHub' 'Custom' 'DocDb' 'EventHub' 'MySql' 'NotificationHub' 'PostgreSQL' 'RedisCache' 'ServiceBus' 'SQLAzure' 'SQLServer'

CorsSettings

Name	Description	Value
allowedOrigins	Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all.	string[]

Experiments

Name	Description	Value
rampUpRules	List of ramp-up rules.	RampUpRule[]

HandlerMapping

Name	Description	Value
arguments	Command-line arguments to be passed to the script processor.	string
extension	Requests with this extension will be handled using the specified FastCGI application.	string
scriptProcessor	The absolute path to the FastCGI application.	string

HostingEnvironmentProfile

Name	Description	Value
id	Resource ID of the App Service Environment.	string

HostNameSslState

Name	Description	Value
hostType	Indicates whether the hostname is a standard or repository hostname.	'Repository' 'Standard'
name	Hostname.	string
sslState	SSL type.	'Disabled' 'IpBasedEnabled' 'SniEnabled'
thumbprint	SSL certificate thumbprint.	string
toUpdate	Set to <code>true</code> to update existing hostname.	bool
virtualIP	Virtual IP address assigned to the hostname if IP based SSL is enabled.	string

IpSecurityRestriction

Name	Description	Value
ipAddress	IP address the security restriction is valid for.	string (required)
subnetMask	Subnet mask for the range of IP addresses the restriction is valid for.	string

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity.	'SystemAssigned'

Microsoft.Web/sites/slots

Name	Description	Value
identity	Managed service identity.	ManagedServiceIdentity
kind	Kind of resource.	string
location	Resource Location.	string (required)
name	The resource name	string (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	Site resource specific properties	SiteProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

NameValuePair

Name	Description	Value
name	Pair name.	string
value	Pair value.	string

PushSettings

Name	Description	Value
kind	Kind of resource.	string
properties	PushSettings resource specific properties	PushSettingsProperties

PushSettingsProperties

Name	Description	Value
dynamicTagsJson	Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.	string
isPushEnabled	Gets or sets a flag indicating whether the Push endpoint is enabled.	bool (required)
tagsRequiringAuth	Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.	string
tagWhitelistJson	Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.	string

RampUpRule

Name	Description	Value
actionHostName	Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.	string
changeDecisionCallbackUrl	Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/	string
changeIntervalInMinutes	Specifies interval in minutes to reevaluate ReroutePercentage.	int
changeStep	In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches <code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.	int
maxReroutePercentage	Specifies upper boundary below which ReroutePercentage will stay.	int
minReroutePercentage	Specifies lower boundary above which ReroutePercentage will stay.	int
name	Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.	string
reroutePercentage	Percentage of the traffic which will be redirected to <code>ActionHostName</code>.	int

RequestsBasedTrigger

Name	Description	Value
count	Request Count.	int
timeInterval	Time interval.	string

ResourceTags

Name	Description	Value

SiteConfig

Name	Description	Value
alwaysOn	<code>true</code> if Always On is enabled; otherwise, <code>false</code>.	bool
apiDefinition	Information about the formal API definition for the app.	ApiDefinitionInfo
appCommandLine	App command line to launch.	string
appSettings	Application settings.	NameValuePair[]
autoHealEnabled	<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.	bool
autoHealRules	Auto Heal rules.	AutoHealRules
autoSwapSlotName	Auto-swap slot name.	string
connectionStrings	Connection strings.	ConnStringInfo[]
cors	Cross-Origin Resource Sharing (CORS) settings.	CorsSettings
defaultDocuments	Default documents.	string[]
detailedErrorLoggingEnabled	<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.	bool
documentRoot	Document root.	string
experiments	This is work around for polymorphic types.	Experiments
handlerMappings	Handler mappings.	HandlerMapping[]
http20Enabled	Http20Enabled: configures a web site to allow clients to connect over http2.0	bool
httpLoggingEnabled	<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.	bool
ipSecurityRestrictions	IP security restrictions.	IpSecurityRestriction[]
javaContainer	Java container.	string
javaContainerVersion	Java container version.	string
javaVersion	Java version.	string
limits	Site limits.	SiteLimits
linuxFxVersion	Linux App Framework and version	string
loadBalancing	Site load balancing.	'LeastRequests' 'LeastResponseTime' 'RequestHash' 'WeightedRoundRobin' 'WeightedTotalTraffic'
localMySqlEnabled	<code>true</code> to enable local MySQL; otherwise, <code>false</code>.	bool
logsDirectorySizeLimit	HTTP logs directory size limit.	int
managedPipelineMode	Managed pipeline mode.	'Classic' 'Integrated'
minTlsVersion	MinTlsVersion: configures the minimum version of TLS required for SSL requests	'1.0' '1.1' '1.2'
netFrameworkVersion	.NET Framework version.	string
nodeVersion	Version of Node.js.	string
numberOfWorkers	Number of workers.	int
phpVersion	Version of PHP.	string
publishingUsername	Publishing user name.	string
push	Push endpoint settings.	PushSettings
pythonVersion	Version of Python.	string
remoteDebuggingEnabled	<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.	bool
remoteDebuggingVersion	Remote debugging version.	string
requestTracingEnabled	<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.	bool
requestTracingExpirationTime	Request tracing expiration time.	string
scmType	SCM type.	'BitbucketGit' 'BitbucketHg' 'CodePlexGit' 'CodePlexHg' 'Dropbox' 'ExternalGit' 'ExternalHg' 'GitHub' 'LocalGit' 'None' 'OneDrive' 'Tfs' 'VSO'
tracingOptions	Tracing options.	string
use32BitWorkerProcess	<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.	bool
virtualApplications	Virtual applications.	VirtualApplication[]
vnetName	Virtual Network name.	string
webSocketsEnabled	<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.	bool

SiteLimits

Name	Description	Value
maxDiskSizeInMb	Maximum allowed disk size usage in MB.	int
maxMemoryInMb	Maximum allowed memory usage in MB.	int
maxPercentageCpu	Maximum allowed CPU usage percentage.	int

SiteProperties

Name	Description	Value
clientAffinityEnabled	<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.	bool
clientCertEnabled	<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.	bool
cloningInfo	If specified during app creation, the app is cloned from a source app.	CloningInfo
containerSize	Size of the function container.	int
dailyMemoryTimeQuota	Maximum allowed daily memory-time quota (applicable on dynamic apps only).	int
enabled	<code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).	bool
hostingEnvironmentProfile	App Service Environment to use for the app.	HostingEnvironmentProfile
hostNamesDisabled	<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process.	bool
hostNameSslStates	Hostname SSL states are used to manage the SSL bindings for app's hostnames.	HostNameSslState[]
httpsOnly	HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests	bool
reserved	<code>true</code> if reserved; otherwise, <code>false</code>.	bool
scmSiteAlsoStopped	<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.	bool
serverFarmId	Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".	string
siteConfig	Configuration of the app.	SiteConfig
snapshotInfo	If specified during app creation, the app is created from a previous snapshot.	SnapshotRecoveryRequest

SlowRequestsBasedTrigger

Name	Description	Value
count	Request Count.	int
timeInterval	Time interval.	string
timeTaken	Time taken.	string

SnapshotRecoveryRequest

Name	Description	Value
kind	Kind of resource.	string
properties	SnapshotRecoveryRequest resource specific properties	SnapshotRecoveryRequestProperties

SnapshotRecoveryRequestProperties

Name	Description	Value
ignoreConflictingHostNames	If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled.	bool
overwrite	If <code>true</code> the recovery operation can overwrite source app; otherwise, <code>false</code>.	bool (required)
recoverConfiguration	If true, site configuration, in addition to content, will be reverted.	bool
recoveryTarget	Specifies the web app that snapshot contents will be written to.	SnapshotRecoveryTarget
snapshotTime	Point in time in which the app recovery should be attempted, formatted as a DateTime string.	string

SnapshotRecoveryTarget

Name	Description	Value
id	ARM resource ID of the target app. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.	string
location	Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS	string

StatusCodesBasedTrigger

Name	Description	Value
count	Request Count.	int
status	HTTP status code.	int
subStatus	Request Sub Status.	int
timeInterval	Time interval.	string
win32Status	Win32 error code.	int

VirtualApplication

Name	Description	Value
physicalPath	Physical path.	string
preloadEnabled	<code>true</code> if preloading is enabled; otherwise, <code>false</code>.	bool
virtualDirectories	Virtual directories for virtual application.	VirtualDirectory[]
virtualPath	Virtual path.	string

VirtualDirectory

Name	Description	Value
physicalPath	Physical path.	string
virtualPath	Path to virtual application.	string

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Azure Function App with a Deployment Slot	This template provisions a function app on a Premium plan with production slot and an additional deployment slot.
Highly Available Multi-region Web App	This template allows you to create a secure, highly available, multi-region end to end solution with two web apps in different regions behind Azure Front Door
Provision Consumption plan function with a Deployment Slot	This template provisions a function app on a Consumption plan, which is a dynamic hosting plan. The app runs on demand and you're billed per execution, with no standing resource committment. There are other templates available for provisioning on a dedicated hosting plan.
Secure N-tier Web App	This template allows you to create a secure end to end solution with two web apps with staging slots, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint

ARM template resource definition

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

{
  "type": "Microsoft.Web/sites/slots",
  "apiVersion": "2016-08-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "clientAffinityEnabled": "bool",
    "clientCertEnabled": "bool",
    "cloningInfo": {
      "appSettingsOverrides": {
        "{customized property}": "string"
      },
      "cloneCustomHostNames": "bool",
      "cloneSourceControl": "bool",
      "configureLoadBalancing": "bool",
      "correlationId": "string",
      "hostingEnvironment": "string",
      "ignoreQuotas": "bool",
      "overwrite": "bool",
      "sourceWebAppId": "string",
      "trafficManagerProfileId": "string",
      "trafficManagerProfileName": "string"
    },
    "containerSize": "int",
    "dailyMemoryTimeQuota": "int",
    "enabled": "bool",
    "hostingEnvironmentProfile": {
      "id": "string"
    },
    "hostNamesDisabled": "bool",
    "hostNameSslStates": [
      {
        "hostType": "string",
        "name": "string",
        "sslState": "string",
        "thumbprint": "string",
        "toUpdate": "bool",
        "virtualIP": "string"
      }
    ],
    "httpsOnly": "bool",
    "reserved": "bool",
    "scmSiteAlsoStopped": "bool",
    "serverFarmId": "string",
    "siteConfig": {
      "alwaysOn": "bool",
      "apiDefinition": {
        "url": "string"
      },
      "appCommandLine": "string",
      "appSettings": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "autoHealEnabled": "bool",
      "autoHealRules": {
        "actions": {
          "actionType": "string",
          "customAction": {
            "exe": "string",
            "parameters": "string"
          },
          "minProcessExecutionTime": "string"
        },
        "triggers": {
          "privateBytesInKB": "int",
          "requests": {
            "count": "int",
            "timeInterval": "string"
          },
          "slowRequests": {
            "count": "int",
            "timeInterval": "string",
            "timeTaken": "string"
          },
          "statusCodes": [
            {
              "count": "int",
              "status": "int",
              "subStatus": "int",
              "timeInterval": "string",
              "win32Status": "int"
            }
          ]
        }
      },
      "autoSwapSlotName": "string",
      "connectionStrings": [
        {
          "connectionString": "string",
          "name": "string",
          "type": "string"
        }
      ],
      "cors": {
        "allowedOrigins": [ "string" ]
      },
      "defaultDocuments": [ "string" ],
      "detailedErrorLoggingEnabled": "bool",
      "documentRoot": "string",
      "experiments": {
        "rampUpRules": [
          {
            "actionHostName": "string",
            "changeDecisionCallbackUrl": "string",
            "changeIntervalInMinutes": "int",
            "changeStep": "int",
            "maxReroutePercentage": "int",
            "minReroutePercentage": "int",
            "name": "string",
            "reroutePercentage": "int"
          }
        ]
      },
      "handlerMappings": [
        {
          "arguments": "string",
          "extension": "string",
          "scriptProcessor": "string"
        }
      ],
      "http20Enabled": "bool",
      "httpLoggingEnabled": "bool",
      "ipSecurityRestrictions": [
        {
          "ipAddress": "string",
          "subnetMask": "string"
        }
      ],
      "javaContainer": "string",
      "javaContainerVersion": "string",
      "javaVersion": "string",
      "limits": {
        "maxDiskSizeInMb": "int",
        "maxMemoryInMb": "int",
        "maxPercentageCpu": "int"
      },
      "linuxFxVersion": "string",
      "loadBalancing": "string",
      "localMySqlEnabled": "bool",
      "logsDirectorySizeLimit": "int",
      "managedPipelineMode": "string",
      "minTlsVersion": "string",
      "netFrameworkVersion": "string",
      "nodeVersion": "string",
      "numberOfWorkers": "int",
      "phpVersion": "string",
      "publishingUsername": "string",
      "push": {
        "kind": "string",
        "properties": {
          "dynamicTagsJson": "string",
          "isPushEnabled": "bool",
          "tagsRequiringAuth": "string",
          "tagWhitelistJson": "string"
        }
      },
      "pythonVersion": "string",
      "remoteDebuggingEnabled": "bool",
      "remoteDebuggingVersion": "string",
      "requestTracingEnabled": "bool",
      "requestTracingExpirationTime": "string",
      "scmType": "string",
      "tracingOptions": "string",
      "use32BitWorkerProcess": "bool",
      "virtualApplications": [
        {
          "physicalPath": "string",
          "preloadEnabled": "bool",
          "virtualDirectories": [
            {
              "physicalPath": "string",
              "virtualPath": "string"
            }
          ],
          "virtualPath": "string"
        }
      ],
      "vnetName": "string",
      "webSocketsEnabled": "bool"
    },
    "snapshotInfo": {
      "kind": "string",
      "properties": {
        "ignoreConflictingHostNames": "bool",
        "overwrite": "bool",
        "recoverConfiguration": "bool",
        "recoveryTarget": {
          "id": "string",
          "location": "string"
        },
        "snapshotTime": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

ApiDefinitionInfo

Name	Description	Value
url	The URL of the API definition.	string

AutoHealActions

Name	Description	Value
actionType	Predefined action to be taken.	'CustomAction' 'LogEvent' 'Recycle'
customAction	Custom action to be taken.	AutoHealCustomAction
minProcessExecutionTime	Minimum time the process must execute before taking the action	string

AutoHealCustomAction

Name	Description	Value
exe	Executable to be run.	string
parameters	Parameters for the executable.	string

AutoHealRules

Name	Description	Value
actions	Actions to be executed when a rule is triggered.	AutoHealActions
triggers	Conditions that describe when to execute the auto-heal actions.	AutoHealTriggers

AutoHealTriggers

Name	Description	Value
privateBytesInKB	A rule based on private bytes.	int
requests	A rule based on total requests.	RequestsBasedTrigger
slowRequests	A rule based on request execution time.	SlowRequestsBasedTrigger
statusCodes	A rule based on status codes.	StatusCodesBasedTrigger[]

CloningInfo

Name	Description	Value
appSettingsOverrides	Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.	CloningInfoAppSettingsOverrides
cloneCustomHostNames	<code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.	bool
cloneSourceControl	<code>true</code> to clone source control from source app; otherwise, <code>false</code>.	bool
configureLoadBalancing	<code>true</code> to configure load balancing for source and destination app.	bool
correlationId	Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.	string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
hostingEnvironment	App Service Environment.	string
ignoreQuotas	<code>true</code> if quotas should be ignored; otherwise, <code>false</code>.	bool
overwrite	<code>true</code> to overwrite destination app; otherwise, <code>false</code>.	bool
sourceWebAppId	ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.	string (required)
trafficManagerProfileId	ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.	string
trafficManagerProfileName	Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.	string

CloningInfoAppSettingsOverrides

Name	Description	Value

ConnStringInfo

Name	Description	Value
connectionString	Connection string value.	string
name	Name of connection string.	string
type	Type of database.	'ApiHub' 'Custom' 'DocDb' 'EventHub' 'MySql' 'NotificationHub' 'PostgreSQL' 'RedisCache' 'ServiceBus' 'SQLAzure' 'SQLServer'

CorsSettings

Name	Description	Value
allowedOrigins	Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all.	string[]

Experiments

Name	Description	Value
rampUpRules	List of ramp-up rules.	RampUpRule[]

HandlerMapping

Name	Description	Value
arguments	Command-line arguments to be passed to the script processor.	string
extension	Requests with this extension will be handled using the specified FastCGI application.	string
scriptProcessor	The absolute path to the FastCGI application.	string

HostingEnvironmentProfile

Name	Description	Value
id	Resource ID of the App Service Environment.	string

HostNameSslState

Name	Description	Value
hostType	Indicates whether the hostname is a standard or repository hostname.	'Repository' 'Standard'
name	Hostname.	string
sslState	SSL type.	'Disabled' 'IpBasedEnabled' 'SniEnabled'
thumbprint	SSL certificate thumbprint.	string
toUpdate	Set to <code>true</code> to update existing hostname.	bool
virtualIP	Virtual IP address assigned to the hostname if IP based SSL is enabled.	string

IpSecurityRestriction

Name	Description	Value
ipAddress	IP address the security restriction is valid for.	string (required)
subnetMask	Subnet mask for the range of IP addresses the restriction is valid for.	string

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity.	'SystemAssigned'

Microsoft.Web/sites/slots

Name	Description	Value
apiVersion	The api version	'2016-08-01'
identity	Managed service identity.	ManagedServiceIdentity
kind	Kind of resource.	string
location	Resource Location.	string (required)
name	The resource name	string (required)
properties	Site resource specific properties	SiteProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Web/sites/slots'

NameValuePair

Name	Description	Value
name	Pair name.	string
value	Pair value.	string

PushSettings

Name	Description	Value
kind	Kind of resource.	string
properties	PushSettings resource specific properties	PushSettingsProperties

PushSettingsProperties

Name	Description	Value
dynamicTagsJson	Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.	string
isPushEnabled	Gets or sets a flag indicating whether the Push endpoint is enabled.	bool (required)
tagsRequiringAuth	Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.	string
tagWhitelistJson	Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.	string

RampUpRule

Name	Description	Value
actionHostName	Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.	string
changeDecisionCallbackUrl	Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/	string
changeIntervalInMinutes	Specifies interval in minutes to reevaluate ReroutePercentage.	int
changeStep	In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches <code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.	int
maxReroutePercentage	Specifies upper boundary below which ReroutePercentage will stay.	int
minReroutePercentage	Specifies lower boundary above which ReroutePercentage will stay.	int
name	Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.	string
reroutePercentage	Percentage of the traffic which will be redirected to <code>ActionHostName</code>.	int

RequestsBasedTrigger

Name	Description	Value
count	Request Count.	int
timeInterval	Time interval.	string

ResourceTags

Name	Description	Value

SiteConfig

Name	Description	Value
alwaysOn	<code>true</code> if Always On is enabled; otherwise, <code>false</code>.	bool
apiDefinition	Information about the formal API definition for the app.	ApiDefinitionInfo
appCommandLine	App command line to launch.	string
appSettings	Application settings.	NameValuePair[]
autoHealEnabled	<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.	bool
autoHealRules	Auto Heal rules.	AutoHealRules
autoSwapSlotName	Auto-swap slot name.	string
connectionStrings	Connection strings.	ConnStringInfo[]
cors	Cross-Origin Resource Sharing (CORS) settings.	CorsSettings
defaultDocuments	Default documents.	string[]
detailedErrorLoggingEnabled	<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.	bool
documentRoot	Document root.	string
experiments	This is work around for polymorphic types.	Experiments
handlerMappings	Handler mappings.	HandlerMapping[]
http20Enabled	Http20Enabled: configures a web site to allow clients to connect over http2.0	bool
httpLoggingEnabled	<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.	bool
ipSecurityRestrictions	IP security restrictions.	IpSecurityRestriction[]
javaContainer	Java container.	string
javaContainerVersion	Java container version.	string
javaVersion	Java version.	string
limits	Site limits.	SiteLimits
linuxFxVersion	Linux App Framework and version	string
loadBalancing	Site load balancing.	'LeastRequests' 'LeastResponseTime' 'RequestHash' 'WeightedRoundRobin' 'WeightedTotalTraffic'
localMySqlEnabled	<code>true</code> to enable local MySQL; otherwise, <code>false</code>.	bool
logsDirectorySizeLimit	HTTP logs directory size limit.	int
managedPipelineMode	Managed pipeline mode.	'Classic' 'Integrated'
minTlsVersion	MinTlsVersion: configures the minimum version of TLS required for SSL requests	'1.0' '1.1' '1.2'
netFrameworkVersion	.NET Framework version.	string
nodeVersion	Version of Node.js.	string
numberOfWorkers	Number of workers.	int
phpVersion	Version of PHP.	string
publishingUsername	Publishing user name.	string
push	Push endpoint settings.	PushSettings
pythonVersion	Version of Python.	string
remoteDebuggingEnabled	<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.	bool
remoteDebuggingVersion	Remote debugging version.	string
requestTracingEnabled	<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.	bool
requestTracingExpirationTime	Request tracing expiration time.	string
scmType	SCM type.	'BitbucketGit' 'BitbucketHg' 'CodePlexGit' 'CodePlexHg' 'Dropbox' 'ExternalGit' 'ExternalHg' 'GitHub' 'LocalGit' 'None' 'OneDrive' 'Tfs' 'VSO'
tracingOptions	Tracing options.	string
use32BitWorkerProcess	<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.	bool
virtualApplications	Virtual applications.	VirtualApplication[]
vnetName	Virtual Network name.	string
webSocketsEnabled	<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.	bool

SiteLimits

Name	Description	Value
maxDiskSizeInMb	Maximum allowed disk size usage in MB.	int
maxMemoryInMb	Maximum allowed memory usage in MB.	int
maxPercentageCpu	Maximum allowed CPU usage percentage.	int

SiteProperties

Name	Description	Value
clientAffinityEnabled	<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.	bool
clientCertEnabled	<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.	bool
cloningInfo	If specified during app creation, the app is cloned from a source app.	CloningInfo
containerSize	Size of the function container.	int
dailyMemoryTimeQuota	Maximum allowed daily memory-time quota (applicable on dynamic apps only).	int
enabled	<code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).	bool
hostingEnvironmentProfile	App Service Environment to use for the app.	HostingEnvironmentProfile
hostNamesDisabled	<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process.	bool
hostNameSslStates	Hostname SSL states are used to manage the SSL bindings for app's hostnames.	HostNameSslState[]
httpsOnly	HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests	bool
reserved	<code>true</code> if reserved; otherwise, <code>false</code>.	bool
scmSiteAlsoStopped	<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.	bool
serverFarmId	Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".	string
siteConfig	Configuration of the app.	SiteConfig
snapshotInfo	If specified during app creation, the app is created from a previous snapshot.	SnapshotRecoveryRequest

SlowRequestsBasedTrigger

Name	Description	Value
count	Request Count.	int
timeInterval	Time interval.	string
timeTaken	Time taken.	string

SnapshotRecoveryRequest

Name	Description	Value
kind	Kind of resource.	string
properties	SnapshotRecoveryRequest resource specific properties	SnapshotRecoveryRequestProperties

SnapshotRecoveryRequestProperties

Name	Description	Value
ignoreConflictingHostNames	If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled.	bool
overwrite	If <code>true</code> the recovery operation can overwrite source app; otherwise, <code>false</code>.	bool (required)
recoverConfiguration	If true, site configuration, in addition to content, will be reverted.	bool
recoveryTarget	Specifies the web app that snapshot contents will be written to.	SnapshotRecoveryTarget
snapshotTime	Point in time in which the app recovery should be attempted, formatted as a DateTime string.	string

SnapshotRecoveryTarget

Name	Description	Value
id	ARM resource ID of the target app. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.	string
location	Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS	string

StatusCodesBasedTrigger

Name	Description	Value
count	Request Count.	int
status	HTTP status code.	int
subStatus	Request Sub Status.	int
timeInterval	Time interval.	string
win32Status	Win32 error code.	int

VirtualApplication

Name	Description	Value
physicalPath	Physical path.	string
preloadEnabled	<code>true</code> if preloading is enabled; otherwise, <code>false</code>.	bool
virtualDirectories	Virtual directories for virtual application.	VirtualDirectory[]
virtualPath	Virtual path.	string

VirtualDirectory

Name	Description	Value
physicalPath	Physical path.	string
virtualPath	Path to virtual application.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Azure Function App with a Deployment Slot	This template provisions a function app on a Premium plan with production slot and an additional deployment slot.
Highly Available Multi-region Web App	This template allows you to create a secure, highly available, multi-region end to end solution with two web apps in different regions behind Azure Front Door
Provision Consumption plan function with a Deployment Slot	This template provisions a function app on a Consumption plan, which is a dynamic hosting plan. The app runs on demand and you're billed per execution, with no standing resource committment. There are other templates available for provisioning on a dedicated hosting plan.
Secure N-tier Web App	This template allows you to create a secure end to end solution with two web apps with staging slots, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint
Web App with custom Deployment slots	This template provides an easy way to deploy a web app with custom deployment slots on Azure Web Apps.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/slots@2016-08-01"
  name = "string"
  identity = {
    type = "string"
  }
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      clientAffinityEnabled = bool
      clientCertEnabled = bool
      cloningInfo = {
        appSettingsOverrides = {
          {customized property} = "string"
        }
        cloneCustomHostNames = bool
        cloneSourceControl = bool
        configureLoadBalancing = bool
        correlationId = "string"
        hostingEnvironment = "string"
        ignoreQuotas = bool
        overwrite = bool
        sourceWebAppId = "string"
        trafficManagerProfileId = "string"
        trafficManagerProfileName = "string"
      }
      containerSize = int
      dailyMemoryTimeQuota = int
      enabled = bool
      hostingEnvironmentProfile = {
        id = "string"
      }
      hostNamesDisabled = bool
      hostNameSslStates = [
        {
          hostType = "string"
          name = "string"
          sslState = "string"
          thumbprint = "string"
          toUpdate = bool
          virtualIP = "string"
        }
      ]
      httpsOnly = bool
      reserved = bool
      scmSiteAlsoStopped = bool
      serverFarmId = "string"
      siteConfig = {
        alwaysOn = bool
        apiDefinition = {
          url = "string"
        }
        appCommandLine = "string"
        appSettings = [
          {
            name = "string"
            value = "string"
          }
        ]
        autoHealEnabled = bool
        autoHealRules = {
          actions = {
            actionType = "string"
            customAction = {
              exe = "string"
              parameters = "string"
            }
            minProcessExecutionTime = "string"
          }
          triggers = {
            privateBytesInKB = int
            requests = {
              count = int
              timeInterval = "string"
            }
            slowRequests = {
              count = int
              timeInterval = "string"
              timeTaken = "string"
            }
            statusCodes = [
              {
                count = int
                status = int
                subStatus = int
                timeInterval = "string"
                win32Status = int
              }
            ]
          }
        }
        autoSwapSlotName = "string"
        connectionStrings = [
          {
            connectionString = "string"
            name = "string"
            type = "string"
          }
        ]
        cors = {
          allowedOrigins = [
            "string"
          ]
        }
        defaultDocuments = [
          "string"
        ]
        detailedErrorLoggingEnabled = bool
        documentRoot = "string"
        experiments = {
          rampUpRules = [
            {
              actionHostName = "string"
              changeDecisionCallbackUrl = "string"
              changeIntervalInMinutes = int
              changeStep = int
              maxReroutePercentage = int
              minReroutePercentage = int
              name = "string"
              reroutePercentage = int
            }
          ]
        }
        handlerMappings = [
          {
            arguments = "string"
            extension = "string"
            scriptProcessor = "string"
          }
        ]
        http20Enabled = bool
        httpLoggingEnabled = bool
        ipSecurityRestrictions = [
          {
            ipAddress = "string"
            subnetMask = "string"
          }
        ]
        javaContainer = "string"
        javaContainerVersion = "string"
        javaVersion = "string"
        limits = {
          maxDiskSizeInMb = int
          maxMemoryInMb = int
          maxPercentageCpu = int
        }
        linuxFxVersion = "string"
        loadBalancing = "string"
        localMySqlEnabled = bool
        logsDirectorySizeLimit = int
        managedPipelineMode = "string"
        minTlsVersion = "string"
        netFrameworkVersion = "string"
        nodeVersion = "string"
        numberOfWorkers = int
        phpVersion = "string"
        publishingUsername = "string"
        push = {
          kind = "string"
          properties = {
            dynamicTagsJson = "string"
            isPushEnabled = bool
            tagsRequiringAuth = "string"
            tagWhitelistJson = "string"
          }
        }
        pythonVersion = "string"
        remoteDebuggingEnabled = bool
        remoteDebuggingVersion = "string"
        requestTracingEnabled = bool
        requestTracingExpirationTime = "string"
        scmType = "string"
        tracingOptions = "string"
        use32BitWorkerProcess = bool
        virtualApplications = [
          {
            physicalPath = "string"
            preloadEnabled = bool
            virtualDirectories = [
              {
                physicalPath = "string"
                virtualPath = "string"
              }
            ]
            virtualPath = "string"
          }
        ]
        vnetName = "string"
        webSocketsEnabled = bool
      }
      snapshotInfo = {
        kind = "string"
        properties = {
          ignoreConflictingHostNames = bool
          overwrite = bool
          recoverConfiguration = bool
          recoveryTarget = {
            id = "string"
            location = "string"
          }
          snapshotTime = "string"
        }
      }
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

ApiDefinitionInfo

Name	Description	Value
url	The URL of the API definition.	string

AutoHealActions

Name	Description	Value
actionType	Predefined action to be taken.	'CustomAction' 'LogEvent' 'Recycle'
customAction	Custom action to be taken.	AutoHealCustomAction
minProcessExecutionTime	Minimum time the process must execute before taking the action	string

AutoHealCustomAction

Name	Description	Value
exe	Executable to be run.	string
parameters	Parameters for the executable.	string

AutoHealRules

Name	Description	Value
actions	Actions to be executed when a rule is triggered.	AutoHealActions
triggers	Conditions that describe when to execute the auto-heal actions.	AutoHealTriggers

AutoHealTriggers

Name	Description	Value
privateBytesInKB	A rule based on private bytes.	int
requests	A rule based on total requests.	RequestsBasedTrigger
slowRequests	A rule based on request execution time.	SlowRequestsBasedTrigger
statusCodes	A rule based on status codes.	StatusCodesBasedTrigger[]

CloningInfo

Name	Description	Value
appSettingsOverrides	Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.	CloningInfoAppSettingsOverrides
cloneCustomHostNames	<code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.	bool
cloneSourceControl	<code>true</code> to clone source control from source app; otherwise, <code>false</code>.	bool
configureLoadBalancing	<code>true</code> to configure load balancing for source and destination app.	bool
correlationId	Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.	string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
hostingEnvironment	App Service Environment.	string
ignoreQuotas	<code>true</code> if quotas should be ignored; otherwise, <code>false</code>.	bool
overwrite	<code>true</code> to overwrite destination app; otherwise, <code>false</code>.	bool
sourceWebAppId	ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.	string (required)
trafficManagerProfileId	ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.	string
trafficManagerProfileName	Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.	string

CloningInfoAppSettingsOverrides

Name	Description	Value

ConnStringInfo

Name	Description	Value
connectionString	Connection string value.	string
name	Name of connection string.	string
type	Type of database.	'ApiHub' 'Custom' 'DocDb' 'EventHub' 'MySql' 'NotificationHub' 'PostgreSQL' 'RedisCache' 'ServiceBus' 'SQLAzure' 'SQLServer'

CorsSettings

Name	Description	Value
allowedOrigins	Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all.	string[]

Experiments

Name	Description	Value
rampUpRules	List of ramp-up rules.	RampUpRule[]

HandlerMapping

Name	Description	Value
arguments	Command-line arguments to be passed to the script processor.	string
extension	Requests with this extension will be handled using the specified FastCGI application.	string
scriptProcessor	The absolute path to the FastCGI application.	string

HostingEnvironmentProfile

Name	Description	Value
id	Resource ID of the App Service Environment.	string

HostNameSslState

Name	Description	Value
hostType	Indicates whether the hostname is a standard or repository hostname.	'Repository' 'Standard'
name	Hostname.	string
sslState	SSL type.	'Disabled' 'IpBasedEnabled' 'SniEnabled'
thumbprint	SSL certificate thumbprint.	string
toUpdate	Set to <code>true</code> to update existing hostname.	bool
virtualIP	Virtual IP address assigned to the hostname if IP based SSL is enabled.	string

IpSecurityRestriction

Name	Description	Value
ipAddress	IP address the security restriction is valid for.	string (required)
subnetMask	Subnet mask for the range of IP addresses the restriction is valid for.	string

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity.	'SystemAssigned'

Microsoft.Web/sites/slots

Name	Description	Value
identity	Managed service identity.	ManagedServiceIdentity
kind	Kind of resource.	string
location	Resource Location.	string (required)
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: sites
properties	Site resource specific properties	SiteProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Web/sites/slots@2016-08-01"

NameValuePair

Name	Description	Value
name	Pair name.	string
value	Pair value.	string

PushSettings

Name	Description	Value
kind	Kind of resource.	string
properties	PushSettings resource specific properties	PushSettingsProperties

PushSettingsProperties

Name	Description	Value
dynamicTagsJson	Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.	string
isPushEnabled	Gets or sets a flag indicating whether the Push endpoint is enabled.	bool (required)
tagsRequiringAuth	Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.	string
tagWhitelistJson	Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.	string

RampUpRule

Name	Description	Value
actionHostName	Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.	string
changeDecisionCallbackUrl	Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/	string
changeIntervalInMinutes	Specifies interval in minutes to reevaluate ReroutePercentage.	int
changeStep	In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches <code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.	int
maxReroutePercentage	Specifies upper boundary below which ReroutePercentage will stay.	int
minReroutePercentage	Specifies lower boundary above which ReroutePercentage will stay.	int
name	Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.	string
reroutePercentage	Percentage of the traffic which will be redirected to <code>ActionHostName</code>.	int

RequestsBasedTrigger

Name	Description	Value
count	Request Count.	int
timeInterval	Time interval.	string

ResourceTags

Name	Description	Value

SiteConfig

Name	Description	Value
alwaysOn	<code>true</code> if Always On is enabled; otherwise, <code>false</code>.	bool
apiDefinition	Information about the formal API definition for the app.	ApiDefinitionInfo
appCommandLine	App command line to launch.	string
appSettings	Application settings.	NameValuePair[]
autoHealEnabled	<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.	bool
autoHealRules	Auto Heal rules.	AutoHealRules
autoSwapSlotName	Auto-swap slot name.	string
connectionStrings	Connection strings.	ConnStringInfo[]
cors	Cross-Origin Resource Sharing (CORS) settings.	CorsSettings
defaultDocuments	Default documents.	string[]
detailedErrorLoggingEnabled	<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.	bool
documentRoot	Document root.	string
experiments	This is work around for polymorphic types.	Experiments
handlerMappings	Handler mappings.	HandlerMapping[]
http20Enabled	Http20Enabled: configures a web site to allow clients to connect over http2.0	bool
httpLoggingEnabled	<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.	bool
ipSecurityRestrictions	IP security restrictions.	IpSecurityRestriction[]
javaContainer	Java container.	string
javaContainerVersion	Java container version.	string
javaVersion	Java version.	string
limits	Site limits.	SiteLimits
linuxFxVersion	Linux App Framework and version	string
loadBalancing	Site load balancing.	'LeastRequests' 'LeastResponseTime' 'RequestHash' 'WeightedRoundRobin' 'WeightedTotalTraffic'
localMySqlEnabled	<code>true</code> to enable local MySQL; otherwise, <code>false</code>.	bool
logsDirectorySizeLimit	HTTP logs directory size limit.	int
managedPipelineMode	Managed pipeline mode.	'Classic' 'Integrated'
minTlsVersion	MinTlsVersion: configures the minimum version of TLS required for SSL requests	'1.0' '1.1' '1.2'
netFrameworkVersion	.NET Framework version.	string
nodeVersion	Version of Node.js.	string
numberOfWorkers	Number of workers.	int
phpVersion	Version of PHP.	string
publishingUsername	Publishing user name.	string
push	Push endpoint settings.	PushSettings
pythonVersion	Version of Python.	string
remoteDebuggingEnabled	<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.	bool
remoteDebuggingVersion	Remote debugging version.	string
requestTracingEnabled	<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.	bool
requestTracingExpirationTime	Request tracing expiration time.	string
scmType	SCM type.	'BitbucketGit' 'BitbucketHg' 'CodePlexGit' 'CodePlexHg' 'Dropbox' 'ExternalGit' 'ExternalHg' 'GitHub' 'LocalGit' 'None' 'OneDrive' 'Tfs' 'VSO'
tracingOptions	Tracing options.	string
use32BitWorkerProcess	<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.	bool
virtualApplications	Virtual applications.	VirtualApplication[]
vnetName	Virtual Network name.	string
webSocketsEnabled	<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.	bool

SiteLimits

Name	Description	Value
maxDiskSizeInMb	Maximum allowed disk size usage in MB.	int
maxMemoryInMb	Maximum allowed memory usage in MB.	int
maxPercentageCpu	Maximum allowed CPU usage percentage.	int

SiteProperties

Name	Description	Value
clientAffinityEnabled	<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.	bool
clientCertEnabled	<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.	bool
cloningInfo	If specified during app creation, the app is cloned from a source app.	CloningInfo
containerSize	Size of the function container.	int
dailyMemoryTimeQuota	Maximum allowed daily memory-time quota (applicable on dynamic apps only).	int
enabled	<code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).	bool
hostingEnvironmentProfile	App Service Environment to use for the app.	HostingEnvironmentProfile
hostNamesDisabled	<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process.	bool
hostNameSslStates	Hostname SSL states are used to manage the SSL bindings for app's hostnames.	HostNameSslState[]
httpsOnly	HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests	bool
reserved	<code>true</code> if reserved; otherwise, <code>false</code>.	bool
scmSiteAlsoStopped	<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.	bool
serverFarmId	Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".	string
siteConfig	Configuration of the app.	SiteConfig
snapshotInfo	If specified during app creation, the app is created from a previous snapshot.	SnapshotRecoveryRequest

SlowRequestsBasedTrigger

Name	Description	Value
count	Request Count.	int
timeInterval	Time interval.	string
timeTaken	Time taken.	string

SnapshotRecoveryRequest

Name	Description	Value
kind	Kind of resource.	string
properties	SnapshotRecoveryRequest resource specific properties	SnapshotRecoveryRequestProperties

SnapshotRecoveryRequestProperties

Name	Description	Value
ignoreConflictingHostNames	If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled.	bool
overwrite	If <code>true</code> the recovery operation can overwrite source app; otherwise, <code>false</code>.	bool (required)
recoverConfiguration	If true, site configuration, in addition to content, will be reverted.	bool
recoveryTarget	Specifies the web app that snapshot contents will be written to.	SnapshotRecoveryTarget
snapshotTime	Point in time in which the app recovery should be attempted, formatted as a DateTime string.	string

SnapshotRecoveryTarget

Name	Description	Value
id	ARM resource ID of the target app. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.	string
location	Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS	string

StatusCodesBasedTrigger

Name	Description	Value
count	Request Count.	int
status	HTTP status code.	int
subStatus	Request Sub Status.	int
timeInterval	Time interval.	string
win32Status	Win32 error code.	int

VirtualApplication

Name	Description	Value
physicalPath	Physical path.	string
preloadEnabled	<code>true</code> if preloading is enabled; otherwise, <code>false</code>.	bool
virtualDirectories	Virtual directories for virtual application.	VirtualDirectory[]
virtualPath	Virtual path.	string

VirtualDirectory

Name	Description	Value
physicalPath	Physical path.	string
virtualPath	Path to virtual application.	string