SiteConfig

Configuration of an App Service app.

AzureCloudComputeEvent-DrivenMicrosoftServerless

Properties

Name Type Description
numberOfWorkers integer Number of workers.
defaultDocuments array Default documents.
netFrameworkVersion string .NET Framework version.
phpVersion string Version of PHP.
pythonVersion string Version of Python.
nodeVersion string Version of Node.js.
powerShellVersion string Version of PowerShell.
linuxFxVersion string Linux App Framework and version
windowsFxVersion string Xenon App Framework and version
requestTracingEnabled boolean true if request tracing is enabled; otherwise, false.
requestTracingExpirationTime string Request tracing expiration time.
remoteDebuggingEnabled boolean true if remote debugging is enabled; otherwise, false.
remoteDebuggingVersion string Remote debugging version.
httpLoggingEnabled boolean true if HTTP logging is enabled; otherwise, false.
acrUseManagedIdentityCreds boolean Flag to use Managed Identity Creds for ACR pull
acrUserManagedIdentityID string If using user managed identity, the user managed identity ClientId
logsDirectorySizeLimit integer HTTP logs directory size limit.
detailedErrorLoggingEnabled boolean true if detailed error logging is enabled; otherwise, false.
publishingUsername string Publishing user name.
appSettings array Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information.
metadata array Application metadata. This property cannot be retrieved, since it may contain secrets.
connectionStrings array Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information.
machineKey object Site MachineKey.
handlerMappings array Handler mappings.
documentRoot string Document root.
scmType object SCM type.
use32BitWorkerProcess boolean true to use 32-bit worker process; otherwise, false.
webSocketsEnabled boolean true if WebSocket is enabled; otherwise, false.
alwaysOn boolean true if Always On is enabled; otherwise, false.
javaVersion string Java version.
javaContainer string Java container.
javaContainerVersion string Java container version.
appCommandLine string App command line to launch.
managedPipelineMode object Managed pipeline mode.
virtualApplications array Virtual applications.
loadBalancing object Site load balancing.
experiments object This is work around for polymorphic types.
limits object Site limits.
autoHealEnabled boolean true if Auto Heal is enabled; otherwise, false.
autoHealRules object Auto Heal rules.
tracingOptions string Tracing options.
vnetName string Virtual Network name.
vnetRouteAllEnabled boolean Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.
vnetPrivatePortsCount integer The number of private ports assigned to this app. These will be assigned dynamically on runtime.
cors object Cross-Origin Resource Sharing (CORS) settings.
push object Push endpoint settings.
apiDefinition object Information about the formal API definition for the app.
apiManagementConfig object Azure API management settings linked to the app.
autoSwapSlotName string Auto-swap slot name.
localMySqlEnabled boolean true to enable local MySQL; otherwise, false.
managedServiceIdentityId integer Managed Service Identity Id
xManagedServiceIdentityId integer Explicit Managed Service Identity Id
keyVaultReferenceIdentity string Identity to use for Key Vault Reference authentication.
ipSecurityRestrictions array IP security restrictions for main.
ipSecurityRestrictionsDefaultAction object Default action for main access restriction if no rules are matched.
scmIpSecurityRestrictions array IP security restrictions for scm.
scmIpSecurityRestrictionsDefaultAction object Default action for scm access restriction if no rules are matched.
scmIpSecurityRestrictionsUseMain boolean IP security restrictions for scm to use main.
http20Enabled boolean Http20Enabled: configures a web site to allow clients to connect over http2.0
http20ProxyFlag integer Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only.
minTlsVersion object MinTlsVersion: configures the minimum version of TLS required for SSL requests
minTlsCipherSuite object The minimum strength TLS cipher suite allowed for an application
scmMinTlsVersion object ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site
ftpsState object State of FTP / FTPS service
preWarmedInstanceCount integer Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans
functionAppScaleLimit integer Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans
elasticWebAppScaleLimit integer Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true
healthCheckPath string Health check path
functionsRuntimeScaleMonitoringEnabled boolean Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime t
websiteTimeZone string Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects
minimumElasticInstanceCount integer Number of minimum instance count for a site This setting only applies to the Elastic Plans
azureStorageAccounts object List of Azure Storage Accounts.
publicNetworkAccess string Property to allow or block all public traffic.
View JSON Schema on GitHub