SiteConfig interface

Configuration of an App Service app.

Properties

alwaysOn

true if Always On is enabled; otherwise, false.

apiDefinition

Information about the formal API definition for the app.

appCommandLine

App command line to launch.

appSettings

Application settings.

autoHealEnabled

true if Auto Heal is enabled; otherwise, false.

autoHealRules

Auto Heal rules.

autoSwapSlotName

Auto-swap slot name.

azureStorageAccounts

User-provided Azure storage accounts.

connectionStrings

Connection strings.

cors

Cross-Origin Resource Sharing (CORS) settings.

defaultDocuments

Default documents.

detailedErrorLoggingEnabled

true if detailed error logging is enabled; otherwise, false.

documentRoot

Document root.

experiments

This is work around for polymorphic types.

ftpsState

State of FTP / FTPS service

handlerMappings

Handler mappings.

http20Enabled

Http20Enabled: configures a web site to allow clients to connect over http2.0

httpLoggingEnabled

true if HTTP logging is enabled; otherwise, false.

ipSecurityRestrictions

IP security restrictions for main.

javaContainer

Java container.

javaContainerVersion

Java container version.

javaVersion

Java version.

limits

Site limits.

linuxFxVersion

Linux App Framework and version

loadBalancing

Site load balancing.

localMySqlEnabled

true to enable local MySQL; otherwise, false.

logsDirectorySizeLimit

HTTP logs directory size limit.

machineKey

Site MachineKey. NOTE: This property will not be serialized. It can only be populated by the server.

managedPipelineMode

Managed pipeline mode.

managedServiceIdentityId

Managed Service Identity Id

minTlsVersion

MinTlsVersion: configures the minimum version of TLS required for SSL requests

netFrameworkVersion

.NET Framework version.

nodeVersion

Version of Node.js.

numberOfWorkers

Number of workers.

phpVersion

Version of PHP.

publishingUsername

Publishing user name.

push

Push endpoint settings.

pythonVersion

Version of Python.

remoteDebuggingEnabled

true if remote debugging is enabled; otherwise, false.

remoteDebuggingVersion

Remote debugging version.

requestTracingEnabled

true if request tracing is enabled; otherwise, false.

requestTracingExpirationTime

Request tracing expiration time.

reservedInstanceCount

Number of reserved instances. This setting only applies to the Consumption Plan

scmIpSecurityRestrictions

IP security restrictions for scm.

scmIpSecurityRestrictionsUseMain

IP security restrictions for scm to use main.

scmType

SCM type.

tracingOptions

Tracing options.

use32BitWorkerProcess

true to use 32-bit worker process; otherwise, false.

virtualApplications

Virtual applications.

vnetName

Virtual Network name.

webSocketsEnabled

true if WebSocket is enabled; otherwise, false.

windowsFxVersion

Xenon App Framework and version

xManagedServiceIdentityId

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

Application settings.

appSettings?: NameValuePair[]

Property Value

autoHealEnabled

true if Auto Heal is enabled; otherwise, false.

autoHealEnabled?: boolean

Property Value

boolean

autoHealRules

Auto Heal rules.

autoHealRules?: AutoHealRules

Property Value

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

Connection strings.

connectionStrings?: ConnStringInfo[]

Property Value

cors

Cross-Origin Resource Sharing (CORS) settings.

cors?: CorsSettings

Property Value

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

This is work around for polymorphic types.

experiments?: Experiments

Property Value

ftpsState

State of FTP / FTPS service

ftpsState?: string

Property Value

string

handlerMappings

Handler mappings.

handlerMappings?: HandlerMapping[]

Property Value

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

Site limits.

limits?: SiteLimits

Property Value

linuxFxVersion

Linux App Framework and version

linuxFxVersion?: string

Property Value

string

loadBalancing

Site load balancing.

loadBalancing?: SiteLoadBalancing

Property Value

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

Managed pipeline mode.

managedPipelineMode?: ManagedPipelineMode

Property Value

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

Push endpoint settings.

push?: PushSettings

Property Value

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