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?: boolean
Property Value
boolean
apiDefinition
Information about the formal API definition for the app.
apiDefinition?: ApiDefinitionInfo
Property Value
appCommandLine
App command line to launch.
appCommandLine?: string
Property Value
string
appSettings
autoHealEnabled
true
if Auto Heal is enabled; otherwise, false
.
autoHealEnabled?: boolean
Property Value
boolean
autoHealRules
autoSwapSlotName
Auto-swap slot name.
autoSwapSlotName?: string
Property 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?: boolean
Property Value
boolean
documentRoot
Document root.
documentRoot?: string
Property Value
string
experiments
ftpsState
State of FTP / FTPS service
ftpsState?: string
Property Value
string
handlerMappings
http20Enabled
Http20Enabled: configures a web site to allow clients to connect over http2.0
http20Enabled?: boolean
Property Value
boolean
httpLoggingEnabled
true
if HTTP logging is enabled; otherwise, false
.
httpLoggingEnabled?: boolean
Property Value
boolean
ipSecurityRestrictions
IP security restrictions for main.
ipSecurityRestrictions?: IpSecurityRestriction[]
Property Value
javaContainer
Java container.
javaContainer?: string
Property Value
string
javaContainerVersion
Java container version.
javaContainerVersion?: string
Property Value
string
javaVersion
Java version.
javaVersion?: string
Property Value
string
limits
linuxFxVersion
Linux App Framework and version
linuxFxVersion?: string
Property Value
string
loadBalancing
localMySqlEnabled
true
to enable local MySQL; otherwise, false
.
localMySqlEnabled?: boolean
Property Value
boolean
logsDirectorySizeLimit
HTTP logs directory size limit.
logsDirectorySizeLimit?: number
Property Value
number
machineKey
Site MachineKey. NOTE: This property will not be serialized. It can only be populated by the server.
machineKey?: SiteMachineKey
Property Value
managedPipelineMode
managedServiceIdentityId
Managed Service Identity Id
managedServiceIdentityId?: number
Property Value
number
minTlsVersion
MinTlsVersion: configures the minimum version of TLS required for SSL requests
minTlsVersion?: string
Property Value
string
netFrameworkVersion
.NET Framework version.
netFrameworkVersion?: string
Property Value
string
nodeVersion
Version of Node.js.
nodeVersion?: string
Property Value
string
numberOfWorkers
Number of workers.
numberOfWorkers?: number
Property Value
number
phpVersion
Version of PHP.
phpVersion?: string
Property Value
string
publishingUsername
Publishing user name.
publishingUsername?: string
Property Value
string
push
pythonVersion
Version of Python.
pythonVersion?: string
Property Value
string
remoteDebuggingEnabled
true
if remote debugging is enabled; otherwise, false
.
remoteDebuggingEnabled?: boolean
Property Value
boolean
remoteDebuggingVersion
Remote debugging version.
remoteDebuggingVersion?: string
Property Value
string
requestTracingEnabled
true
if request tracing is enabled; otherwise, false
.
requestTracingEnabled?: boolean
Property Value
boolean
requestTracingExpirationTime
Request tracing expiration time.
requestTracingExpirationTime?: Date
Property Value
Date
reservedInstanceCount
Number of reserved instances. This setting only applies to the Consumption Plan
reservedInstanceCount?: number
Property Value
number
scmIpSecurityRestrictions
IP security restrictions for scm.
scmIpSecurityRestrictions?: IpSecurityRestriction[]
Property Value
scmIpSecurityRestrictionsUseMain
IP security restrictions for scm to use main.
scmIpSecurityRestrictionsUseMain?: boolean
Property Value
boolean
scmType
SCM type.
scmType?: string
Property Value
string
tracingOptions
Tracing options.
tracingOptions?: string
Property Value
string
use32BitWorkerProcess
true
to use 32-bit worker process; otherwise, false
.
use32BitWorkerProcess?: boolean
Property Value
boolean
virtualApplications
Virtual applications.
virtualApplications?: VirtualApplication[]
Property Value
vnetName
Virtual Network name.
vnetName?: string
Property Value
string
webSocketsEnabled
true
if WebSocket is enabled; otherwise, false
.
webSocketsEnabled?: boolean
Property Value
boolean
windowsFxVersion
Xenon App Framework and version
windowsFxVersion?: string
Property Value
string
xManagedServiceIdentityId
Explicit Managed Service Identity Id
xManagedServiceIdentityId?: number
Property Value
number