SiteConfigResource interface
Web app configuration ARM resource.
- Extends
Properties
acr |
Flag to use Managed Identity Creds for ACR pull |
acr |
If using user managed identity, the user managed identity ClientId |
always |
|
api |
Information about the formal API definition for the app. |
api |
Azure API management settings linked to the app. |
app |
App command line to launch. |
app |
Application settings. |
auto |
|
auto |
Auto Heal rules. |
auto |
Auto-swap slot name. |
azure |
List of Azure Storage Accounts. |
connection |
Connection strings. |
cors | Cross-Origin Resource Sharing (CORS) settings. |
default |
Default documents. |
detailed |
|
document |
Document root. |
elastic |
Maximum number of workers that a site can scale out to.
This setting only applies to apps in plans where ElasticScaleEnabled is |
experiments | This is work around for polymorphic types. |
ftps |
State of FTP / FTPS service |
function |
Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans |
functions |
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 to get scale status. |
handler |
Handler mappings. |
health |
Health check path |
http20Enabled | Http20Enabled: configures a web site to allow clients to connect over http2.0 |
http |
|
ip |
IP security restrictions for main. |
ip |
Default action for main access restriction if no rules are matched. |
java |
Java container. |
java |
Java container version. |
java |
Java version. |
key |
Identity to use for Key Vault Reference authentication. |
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 |
metadata | Application metadata. This property cannot be retrieved, since it may contain secrets. |
minimum |
Number of minimum instance count for a site This setting only applies to the Elastic Plans |
min |
The minimum strength TLS cipher suite allowed for an application |
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. |
power |
Version of PowerShell. |
pre |
Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans |
public |
Property to allow or block all public traffic. |
publishing |
Publishing user name. |
push | Push endpoint settings. |
python |
Version of Python. |
remote |
|
remote |
Remote debugging version. |
request |
|
request |
Request tracing expiration time. |
scm |
IP security restrictions for scm. |
scm |
Default action for scm access restriction if no rules are matched. |
scm |
IP security restrictions for scm to use main. |
scm |
ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site |
scm |
SCM type. |
tracing |
Tracing options. |
use32Bit |
|
virtual |
Virtual applications. |
vnet |
Virtual Network name. |
vnet |
The number of private ports assigned to this app. These will be assigned dynamically on runtime. |
vnet |
Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. |
website |
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 tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones |
web |
|
windows |
Xenon App Framework and version |
x |
Explicit Managed Service Identity Id |
Inherited Properties
id | Resource Id. NOTE: This property will not be serialized. It can only be populated by the server. |
kind | Kind of resource. |
name | Resource Name. NOTE: This property will not be serialized. It can only be populated by the server. |
type | Resource type. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
acrUseManagedIdentityCreds
Flag to use Managed Identity Creds for ACR pull
acrUseManagedIdentityCreds?: boolean
Property Value
boolean
acrUserManagedIdentityID
If using user managed identity, the user managed identity ClientId
acrUserManagedIdentityID?: string
Property Value
string
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
apiManagementConfig
Azure API management settings linked to the app.
apiManagementConfig?: ApiManagementConfig
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
List of 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
elasticWebAppScaleLimit
Maximum number of workers that a site can scale out to.
This setting only applies to apps in plans where ElasticScaleEnabled is true
elasticWebAppScaleLimit?: number
Property Value
number
experiments
ftpsState
State of FTP / FTPS service
ftpsState?: string
Property Value
string
functionAppScaleLimit
Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans
functionAppScaleLimit?: number
Property Value
number
functionsRuntimeScaleMonitoringEnabled
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 to get scale status.
functionsRuntimeScaleMonitoringEnabled?: boolean
Property Value
boolean
handlerMappings
healthCheckPath
Health check path
healthCheckPath?: string
Property Value
string
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
ipSecurityRestrictionsDefaultAction
Default action for main access restriction if no rules are matched.
ipSecurityRestrictionsDefaultAction?: string
Property Value
string
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
keyVaultReferenceIdentity
Identity to use for Key Vault Reference authentication.
keyVaultReferenceIdentity?: 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
metadata
Application metadata. This property cannot be retrieved, since it may contain secrets.
metadata?: NameValuePair[]
Property Value
minimumElasticInstanceCount
Number of minimum instance count for a site This setting only applies to the Elastic Plans
minimumElasticInstanceCount?: number
Property Value
number
minTlsCipherSuite
The minimum strength TLS cipher suite allowed for an application
minTlsCipherSuite?: string
Property Value
string
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
powerShellVersion
Version of PowerShell.
powerShellVersion?: string
Property Value
string
preWarmedInstanceCount
Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans
preWarmedInstanceCount?: number
Property Value
number
publicNetworkAccess
Property to allow or block all public traffic.
publicNetworkAccess?: 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
scmIpSecurityRestrictions
IP security restrictions for scm.
scmIpSecurityRestrictions?: IpSecurityRestriction[]
Property Value
scmIpSecurityRestrictionsDefaultAction
Default action for scm access restriction if no rules are matched.
scmIpSecurityRestrictionsDefaultAction?: string
Property Value
string
scmIpSecurityRestrictionsUseMain
IP security restrictions for scm to use main.
scmIpSecurityRestrictionsUseMain?: boolean
Property Value
boolean
scmMinTlsVersion
ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site
scmMinTlsVersion?: string
Property Value
string
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
vnetPrivatePortsCount
The number of private ports assigned to this app. These will be assigned dynamically on runtime.
vnetPrivatePortsCount?: number
Property Value
number
vnetRouteAllEnabled
Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.
vnetRouteAllEnabled?: boolean
Property Value
boolean
websiteTimeZone
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 tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones
websiteTimeZone?: 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
Inherited Property Details
id
Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
Inherited From ProxyOnlyResource.id
kind
name
Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From ProxyOnlyResource.name
type
Resource type. NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From ProxyOnlyResource.type