SiteConfigProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Configuration of an App Service app.
public class SiteConfigProperties : Azure.Provisioning.Primitives.ProvisionableConstruct
type SiteConfigProperties = class
inherit ProvisionableConstruct
Public Class SiteConfigProperties
Inherits ProvisionableConstruct
- Inheritance
Constructors
| Name | Description |
|---|---|
| SiteConfigProperties() |
Creates a new SiteConfigProperties. |
Properties
| Name | Description |
|---|---|
| AcrUserManagedIdentityId |
If using user managed identity, the user managed identity ClientId. |
| AllowIPSecurityRestrictionsForScmToUseMain |
IP security restrictions for scm to use main. |
| ApiDefinitionUri |
The URL of the API definition. |
| ApiManagementConfigId |
APIM-Api Identifier. |
| AppCommandLine |
App command line to launch. |
| AppSettings |
Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. |
| AutoHealRules |
Auto Heal rules. |
| AutoSwapSlotName |
Auto-swap slot name. |
| AzureStorageAccounts |
List of Azure Storage Accounts. |
| ConnectionStrings |
Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. |
| Cors |
Cross-Origin Resource Sharing (CORS) settings. |
| DefaultDocuments |
Default documents. |
| DocumentRoot |
Document root. |
| ElasticWebAppScaleLimit |
Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code> |
| ExperimentsRampUpRules |
List of ramp-up rules. |
| FtpsState |
State of FTP / FTPS service. |
| FunctionAppScaleLimit |
Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans |
| HandlerMappings |
Handler mappings. |
| HealthCheckPath |
Health check path. |
| Http20ProxyFlag |
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. |
| IPSecurityRestrictions |
IP security restrictions for main. |
| IPSecurityRestrictionsDefaultAction |
Default action for main access restriction if no rules are matched. |
| IsAlwaysOn |
<code>true</code> if Always On is enabled; otherwise, <code>false</code>. |
| IsAutoHealEnabled |
<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. |
| IsDetailedErrorLoggingEnabled |
<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. |
| IsFunctionsRuntimeScaleMonitoringEnabled |
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. |
| IsHttp20Enabled |
Http20Enabled: configures a web site to allow clients to connect over http2.0. |
| IsHttpLoggingEnabled |
<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. |
| IsLocalMySqlEnabled |
<code>true</code> to enable local MySQL; otherwise, <code>false</code>. |
| IsRemoteDebuggingEnabled |
<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. |
| IsRequestTracingEnabled |
<code>true</code> if request tracing is enabled; otherwise, <code>false</code>. |
| IsVnetRouteAllEnabled |
Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. |
| IsWebSocketsEnabled |
<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. |
| JavaContainer |
Java container. |
| JavaContainerVersion |
Java container version. |
| JavaVersion |
Java version. |
| KeyVaultReferenceIdentity |
Identity to use for Key Vault Reference authentication. |
| Limits |
Site limits. |
| LinuxFxVersion |
Linux App Framework and version. |
| LoadBalancing |
Site load balancing. |
| LogsDirectorySizeLimit |
HTTP logs directory size limit. |
| MachineKey |
Site MachineKey. |
| ManagedPipelineMode |
Managed pipeline mode. |
| ManagedServiceIdentityId |
Managed Service Identity Id. |
| Metadata |
Application metadata. This property cannot be retrieved, since it may contain secrets. |
| MinimumElasticInstanceCount |
Number of minimum instance count for a site This setting only applies to the Elastic Plans |
| MinTlsCipherSuite |
The minimum strength TLS cipher suite allowed for an application. |
| 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. |
| PowerShellVersion |
Version of PowerShell. |
| PreWarmedInstanceCount |
Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans |
| PublicNetworkAccess |
Property to allow or block all public traffic. |
| PublishingUsername |
Publishing user name. |
| Push |
Push endpoint settings. |
| PythonVersion |
Version of Python. |
| RemoteDebuggingVersion |
Remote debugging version. |
| RequestTracingExpirationOn |
Request tracing expiration time. |
| ScmIPSecurityRestrictions |
IP security restrictions for scm. |
| ScmIPSecurityRestrictionsDefaultAction |
Default action for scm access restriction if no rules are matched. |
| ScmMinTlsVersion |
ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site. |
| ScmType |
SCM type. |
| TracingOptions |
Tracing options. |
| Use32BitWorkerProcess |
<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. |
| UseManagedIdentityCreds |
Flag to use Managed Identity Creds for ACR pull. |
| VirtualApplications |
Virtual applications. |
| VnetName |
Virtual Network name. |
| VnetPrivatePortsCount |
The number of private ports assigned to this app. These will be assigned dynamically on runtime. |
| 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. |
| WindowsFxVersion |
Xenon App Framework and version. |
| XManagedServiceIdentityId |
Explicit Managed Service Identity Id. |
Methods
Explicit Interface Implementations
| Name | Description |
|---|---|
| IBicepValue.Assign(IBicepValue) |
Assign a value to this property. (Inherited from ProvisionableConstruct) |
| IBicepValue.Compile() |
Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct) |
| IBicepValue.Expression |
Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsEmpty |
Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsOutput |
Tracks whether this is an output only property. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsRequired |
Tracks whether this property is required. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsSecure |
Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct) |
| IBicepValue.Kind |
Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct) |
| IBicepValue.LiteralValue |
Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct) |
| IBicepValue.Self |
Gets information about where this value was defined. (Inherited from ProvisionableConstruct) |
| IBicepValue.SetReadOnly() |
Make this value readonly. (Inherited from ProvisionableConstruct) |
| IBicepValue.Source |
Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct) |
Extension Methods
| Name | Description |
|---|---|
| ToBicepExpression(IBicepValue) |
Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy. |