true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).
hostNameSslStates
array
No
Hostname SSL states are used to manage the SSL bindings for app's hostnames. - HostNameSslState object
serverFarmId
string
No
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.
clientCertEnabled
boolean
No
true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.
hostNamesDisabled
boolean
No
true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.
containerSize
integer
No
Size of the function container.
dailyMemoryTimeQuota
integer
No
Maximum allowed daily memory-time quota (applicable on dynamic apps only).
cloningInfo
object
No
If specified during app creation, the app is cloned from a source app. - CloningInfo object
httpsOnly
boolean
No
HttpsOnly: configures a web site to accept only https requests. Issues redirect forhttp requests
ManagedServiceIdentity object
Name
Type
Required
Value
type
enum
No
Type of managed service identity. - SystemAssigned or UserAssigned
identityIds
array
No
Array of UserAssigned managed service identities. - string
HostNameSslState object
Name
Type
Required
Value
name
string
No
Hostname.
sslState
enum
No
SSL type. - Disabled, SniEnabled, IpBasedEnabled
virtualIP
string
No
Virtual IP address assigned to the hostname if IP based SSL is enabled.
thumbprint
string
No
SSL certificate thumbprint.
toUpdate
boolean
No
Set to true to update existing hostname.
hostType
enum
No
Indicates whether the hostname is a standard or repository hostname. - Standard or Repository
SiteConfig object
Name
Type
Required
Value
numberOfWorkers
integer
No
Number of workers.
defaultDocuments
array
No
Default documents. - string
netFrameworkVersion
string
No
.NET Framework version.
phpVersion
string
No
Version of PHP.
pythonVersion
string
No
Version of Python.
nodeVersion
string
No
Version of Node.js.
linuxFxVersion
string
No
Linux App Framework and version
windowsFxVersion
string
No
Xenon App Framework and version
requestTracingEnabled
boolean
No
true if request tracing is enabled; otherwise, false.
requestTracingExpirationTime
string
No
Request tracing expiration time.
remoteDebuggingEnabled
boolean
No
true if remote debugging is enabled; otherwise, false.
remoteDebuggingVersion
string
No
Remote debugging version.
httpLoggingEnabled
boolean
No
true if HTTP logging is enabled; otherwise, false.
logsDirectorySizeLimit
integer
No
HTTP logs directory size limit.
detailedErrorLoggingEnabled
boolean
No
true if detailed error logging is enabled; otherwise, false.
Http20Enabled: configures a web site to allow clients to connect over http2.0
minTlsVersion
enum
No
MinTlsVersion: configures the minimum version of TLS required for SSL requests. - 1.0, 1.1, 1.2
ftpsState
enum
No
State of FTP / FTPS service. - AllAllowed, FtpsOnly, Disabled
reservedInstanceCount
integer
No
Number of reserved instances.This setting only applies to the Consumption Plan
HostingEnvironmentProfile object
Name
Type
Required
Value
id
string
No
Resource ID of the App Service Environment.
CloningInfo object
Name
Type
Required
Value
correlationId
string
No
Correlation ID of cloning operation. This ID ties multiple cloning operationstogether to use the same snapshot. - globally unique identifier
overwrite
boolean
No
true to overwrite destination app; otherwise, false.
cloneCustomHostNames
boolean
No
true to clone custom hostnames from source app; otherwise, false.
cloneSourceControl
boolean
No
true to clone source control from source app; otherwise, false.
sourceWebAppId
string
Yes
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.
hostingEnvironment
string
No
App Service Environment.
appSettingsOverrides
object
No
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.
configureLoadBalancing
boolean
No
true to configure load balancing for source and destination app.
trafficManagerProfileId
string
No
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}.
trafficManagerProfileName
string
No
Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.
NameValuePair object
Name
Type
Required
Value
name
string
No
Pair name.
value
string
No
Pair value.
ConnStringInfo object
Name
Type
Required
Value
name
string
No
Name of connection string.
connectionString
string
No
Connection string value.
type
enum
No
Type of database. - MySql, SQLServer, SQLAzure, Custom, NotificationHub, ServiceBus, EventHub, ApiHub, DocDb, RedisCache, PostgreSQL
HandlerMapping object
Name
Type
Required
Value
extension
string
No
Requests with this extension will be handled using the specified FastCGI application.
scriptProcessor
string
No
The absolute path to the FastCGI application.
arguments
string
No
Command-line arguments to be passed to the script processor.
Gets or sets the list of origins that should be allowed to make cross-origincalls (for example: http://example.com:12345). Use "*" to allow all. - string
IP address the security restriction is valid for.It can be in form of pure ipv4 address (required SubnetMask property) orCIDR notation such as ipv4/mask (leading bit match). For CIDR,SubnetMask property must not be specified.
subnetMask
string
No
Subnet mask for the range of IP addresses the restriction is valid for.
action
string
No
Allow or Deny access for this IP range.
tag
enum
No
Defines what this IP filter will be used for. This is to support IP filtering on proxies. - Default or XffProxy
priority
integer
No
Priority of IP restriction rule.
name
string
No
IP restriction rule name.
description
string
No
IP restriction rule description.
VirtualDirectory object
Name
Type
Required
Value
virtualPath
string
No
Path to virtual application.
physicalPath
string
No
Physical path.
RampUpRule object
Name
Type
Required
Value
actionHostName
string
No
Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.
reroutePercentage
number
No
Percentage of the traffic which will be redirected to ActionHostName.
changeStep
number
No
In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.
changeIntervalInMinutes
integer
No
Specifies interval in minutes to reevaluate ReroutePercentage.
minReroutePercentage
number
No
Specifies lower boundary above which ReroutePercentage will stay.
maxReroutePercentage
number
No
Specifies upper boundary below which ReroutePercentage will stay.
changeDecisionCallbackUrl
string
No
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/
name
string
No
Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.
Minimum time the process must executebefore taking the action
PushSettingsProperties object
Name
Type
Required
Value
isPushEnabled
boolean
Yes
Gets or sets a flag indicating whether the Push endpoint is enabled.
tagWhitelistJson
string
No
Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.
tagsRequiringAuth
string
No
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.
dynamicTagsJson
string
No
Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.
