SiteConfig interface
Configuration of an App Service app.
Properties
| always |
|
| api |
Information about the formal API definition for the app. |
| app |
App command line to launch. |
| app |
Application settings. |
| auto |
|
| auto |
Auto Heal rules. |
| auto |
Auto-swap slot name. |
| azure |
User-provided Azure storage accounts. |
| connection |
Connection strings. |
| cors | Cross-Origin Resource Sharing (CORS) settings. |
| default |
Default documents. |
| detailed |
|
| document |
Document root. |
| experiments | This is work around for polymorphic types. |
| ftps |
State of FTP / FTPS service |
| handler |
Handler mappings. |
| http20Enabled | Http20Enabled: configures a web site to allow clients to connect over http2.0 |
| http |
|
| ip |
IP security restrictions for main. |
| java |
Java container. |
| java |
Java container version. |
| java |
Java version. |
| limits | Site limits. |
| linux |
Linux App Framework and version |
| load |
Site load balancing. |
| local |
|
| logs |
HTTP logs directory size limit. |
| machine |
Site MachineKey. NOTE: This property will not be serialized. It can only be populated by the server. |
| managed |
Managed pipeline mode. |
| managed |
Managed Service Identity Id |
| min |
MinTlsVersion: configures the minimum version of TLS required for SSL requests |
| net |
.NET Framework version. |
| node |
Version of Node.js. |
| number |
Number of workers. |
| php |
Version of PHP. |
| publishing |
Publishing user name. |
| push | Push endpoint settings. |
| python |
Version of Python. |
| remote |
|
| remote |
Remote debugging version. |
| request |
|
| request |
Request tracing expiration time. |
| reserved |
Number of reserved instances. This setting only applies to the Consumption Plan |
| scm |
IP security restrictions for scm. |
| scm |
IP security restrictions for scm to use main. |
| scm |
SCM type. |
| tracing |
Tracing options. |
| use32Bit |
|
| virtual |
Virtual applications. |
| vnet |
Virtual Network name. |
| web |
|
| windows |
Xenon App Framework and version |
| x |
Explicit Managed Service Identity Id |
Property Details
alwaysOn
true if Always On is enabled; otherwise, false.
alwaysOn?: booleanProperty Value
boolean
apiDefinition
Information about the formal API definition for the app.
apiDefinition?: ApiDefinitionInfoProperty Value
appCommandLine
App command line to launch.
appCommandLine?: stringProperty Value
string
appSettings
autoHealEnabled
true if Auto Heal is enabled; otherwise, false.
autoHealEnabled?: booleanProperty Value
boolean
autoHealRules
autoSwapSlotName
Auto-swap slot name.
autoSwapSlotName?: stringProperty Value
string
azureStorageAccounts
User-provided Azure storage accounts.
azureStorageAccounts?: {[propertyName: string]: AzureStorageInfoValue}Property Value
{[propertyName: string]: AzureStorageInfoValue}
connectionStrings
cors
defaultDocuments
Default documents.
defaultDocuments?: string[]Property Value
string[]
detailedErrorLoggingEnabled
true if detailed error logging is enabled; otherwise, false.
detailedErrorLoggingEnabled?: booleanProperty Value
boolean
documentRoot
Document root.
documentRoot?: stringProperty Value
string
experiments
ftpsState
State of FTP / FTPS service
ftpsState?: stringProperty Value
string
handlerMappings
http20Enabled
Http20Enabled: configures a web site to allow clients to connect over http2.0
http20Enabled?: booleanProperty Value
boolean
httpLoggingEnabled
true if HTTP logging is enabled; otherwise, false.
httpLoggingEnabled?: booleanProperty Value
boolean
ipSecurityRestrictions
IP security restrictions for main.
ipSecurityRestrictions?: IpSecurityRestriction[]Property Value
javaContainer
Java container.
javaContainer?: stringProperty Value
string
javaContainerVersion
Java container version.
javaContainerVersion?: stringProperty Value
string
javaVersion
Java version.
javaVersion?: stringProperty Value
string
limits
linuxFxVersion
Linux App Framework and version
linuxFxVersion?: stringProperty Value
string
loadBalancing
localMySqlEnabled
true to enable local MySQL; otherwise, false.
localMySqlEnabled?: booleanProperty Value
boolean
logsDirectorySizeLimit
HTTP logs directory size limit.
logsDirectorySizeLimit?: numberProperty Value
number
machineKey
Site MachineKey. NOTE: This property will not be serialized. It can only be populated by the server.
machineKey?: SiteMachineKeyProperty Value
managedPipelineMode
managedServiceIdentityId
Managed Service Identity Id
managedServiceIdentityId?: numberProperty Value
number
minTlsVersion
MinTlsVersion: configures the minimum version of TLS required for SSL requests
minTlsVersion?: stringProperty Value
string
netFrameworkVersion
.NET Framework version.
netFrameworkVersion?: stringProperty Value
string
nodeVersion
Version of Node.js.
nodeVersion?: stringProperty Value
string
numberOfWorkers
Number of workers.
numberOfWorkers?: numberProperty Value
number
phpVersion
Version of PHP.
phpVersion?: stringProperty Value
string
publishingUsername
Publishing user name.
publishingUsername?: stringProperty Value
string
push
pythonVersion
Version of Python.
pythonVersion?: stringProperty Value
string
remoteDebuggingEnabled
true if remote debugging is enabled; otherwise, false.
remoteDebuggingEnabled?: booleanProperty Value
boolean
remoteDebuggingVersion
Remote debugging version.
remoteDebuggingVersion?: stringProperty Value
string
requestTracingEnabled
true if request tracing is enabled; otherwise, false.
requestTracingEnabled?: booleanProperty Value
boolean
requestTracingExpirationTime
Request tracing expiration time.
requestTracingExpirationTime?: DateProperty Value
Date
reservedInstanceCount
Number of reserved instances. This setting only applies to the Consumption Plan
reservedInstanceCount?: numberProperty Value
number
scmIpSecurityRestrictions
IP security restrictions for scm.
scmIpSecurityRestrictions?: IpSecurityRestriction[]Property Value
scmIpSecurityRestrictionsUseMain
IP security restrictions for scm to use main.
scmIpSecurityRestrictionsUseMain?: booleanProperty Value
boolean
scmType
SCM type.
scmType?: stringProperty Value
string
tracingOptions
Tracing options.
tracingOptions?: stringProperty Value
string
use32BitWorkerProcess
true to use 32-bit worker process; otherwise, false.
use32BitWorkerProcess?: booleanProperty Value
boolean
virtualApplications
Virtual applications.
virtualApplications?: VirtualApplication[]Property Value
vnetName
Virtual Network name.
vnetName?: stringProperty Value
string
webSocketsEnabled
true if WebSocket is enabled; otherwise, false.
webSocketsEnabled?: booleanProperty Value
boolean
windowsFxVersion
Xenon App Framework and version
windowsFxVersion?: stringProperty Value
string
xManagedServiceIdentityId
Explicit Managed Service Identity Id
xManagedServiceIdentityId?: numberProperty Value
number