Share via


SiteConfig Class

Definition

Configuration of an App Service app.

public class SiteConfig
type SiteConfig = class
Public Class SiteConfig
Inheritance
SiteConfig

Constructors

SiteConfig()

Initializes a new instance of the SiteConfig class.

SiteConfig(Nullable<Int32>, IList<String>, String, String, String, String, String, String, String, Nullable<Boolean>, Nullable<DateTime>, Nullable<Boolean>, String, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Int32>, Nullable<Boolean>, String, IList<NameValuePair>, IList<ConnStringInfo>, SiteMachineKey, IList<HandlerMapping>, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, String, String, String, Nullable<ManagedPipelineMode>, IList<VirtualApplication>, Nullable<SiteLoadBalancing>, Experiments, SiteLimits, Nullable<Boolean>, AutoHealRules, String, String, Nullable<Boolean>, Nullable<Int32>, CorsSettings, PushSettings, ApiDefinitionInfo, ApiManagementConfig, String, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String, IList<IpSecurityRestriction>, IList<IpSecurityRestriction>, Nullable<Boolean>, Nullable<Boolean>, String, String, String, Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, String, Nullable<Int32>, IDictionary<String, AzureStorageInfoValue>, String)

Initializes a new instance of the SiteConfig class.

Properties

AcrUseManagedIdentityCreds

Gets or sets flag to use Managed Identity Creds for ACR pull

AcrUserManagedIdentityID

Gets or sets if using user managed identity, the user managed identity ClientId

AlwaysOn

Gets or sets &lt;code&gt;true&lt;/code&gt; if Always On is enabled; otherwise, &lt;code&gt;false&lt;/code&gt;.

ApiDefinition

Gets or sets information about the formal API definition for the app.

ApiManagementConfig

Gets or sets azure API management settings linked to the app.

AppCommandLine

Gets or sets app command line to launch.

AppSettings

Gets or sets application settings.

AutoHealEnabled

Gets or sets &lt;code&gt;true&lt;/code&gt; if Auto Heal is enabled; otherwise, &lt;code&gt;false&lt;/code&gt;.

AutoHealRules

Gets or sets auto Heal rules.

AutoSwapSlotName

Gets or sets auto-swap slot name.

AzureStorageAccounts

Gets or sets list of Azure Storage Accounts.

ConnectionStrings

Gets or sets connection strings.

Cors

Gets or sets cross-Origin Resource Sharing (CORS) settings.

DefaultDocuments

Gets or sets default documents.

DetailedErrorLoggingEnabled

Gets or sets &lt;code&gt;true&lt;/code&gt; if detailed error logging is enabled; otherwise, &lt;code&gt;false&lt;/code&gt;.

DocumentRoot

Gets or sets document root.

Experiments

Gets or sets this is work around for polymorphic types.

FtpsState

Gets or sets state of FTP / FTPS service. Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'

FunctionAppScaleLimit

Gets or sets maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans

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.

HandlerMappings

Gets or sets handler mappings.

HealthCheckPath

Gets or sets health check path

Http20Enabled

Gets or sets http20Enabled: configures a web site to allow clients to connect over http2.0

HttpLoggingEnabled

Gets or sets &lt;code&gt;true&lt;/code&gt; if HTTP logging is enabled; otherwise, &lt;code&gt;false&lt;/code&gt;.

IpSecurityRestrictions

Gets or sets IP security restrictions for main.

JavaContainer

Gets or sets java container.

JavaContainerVersion

Gets or sets java container version.

JavaVersion

Gets or sets java version.

KeyVaultReferenceIdentity

Gets or sets identity to use for Key Vault Reference authentication.

Limits

Gets or sets site limits.

LinuxFxVersion

Gets or sets linux App Framework and version

LoadBalancing

Gets or sets site load balancing. Possible values include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash', 'PerSiteRoundRobin'

LocalMySqlEnabled

Gets or sets &lt;code&gt;true&lt;/code&gt; to enable local MySQL; otherwise, &lt;code&gt;false&lt;/code&gt;.

LogsDirectorySizeLimit

Gets or sets HTTP logs directory size limit.

MachineKey

Gets site MachineKey.

ManagedPipelineMode

Gets or sets managed pipeline mode. Possible values include: 'Integrated', 'Classic'

ManagedServiceIdentityId

Gets or sets managed Service Identity Id

MinimumElasticInstanceCount

Gets or sets number of minimum instance count for a site This setting only applies to the Elastic Plans

MinTlsVersion

Gets or sets minTlsVersion: configures the minimum version of TLS required for SSL requests. Possible values include: '1.0', '1.1', '1.2'

NetFrameworkVersion

Gets or sets .NET Framework version.

NodeVersion

Gets or sets version of Node.js.

NumberOfWorkers

Gets or sets number of workers.

PhpVersion

Gets or sets version of PHP.

PowerShellVersion

Gets or sets version of PowerShell.

PreWarmedInstanceCount

Gets or sets number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans

PublicNetworkAccess

Gets or sets property to allow or block all public traffic.

PublishingUsername

Gets or sets publishing user name.

Push

Gets or sets push endpoint settings.

PythonVersion

Gets or sets version of Python.

RemoteDebuggingEnabled

Gets or sets &lt;code&gt;true&lt;/code&gt; if remote debugging is enabled; otherwise, &lt;code&gt;false&lt;/code&gt;.

RemoteDebuggingVersion

Gets or sets remote debugging version.

RequestTracingEnabled

Gets or sets &lt;code&gt;true&lt;/code&gt; if request tracing is enabled; otherwise, &lt;code&gt;false&lt;/code&gt;.

RequestTracingExpirationTime

Gets or sets request tracing expiration time.

ScmIpSecurityRestrictions

Gets or sets IP security restrictions for scm.

ScmIpSecurityRestrictionsUseMain

Gets or sets IP security restrictions for scm to use main.

ScmMinTlsVersion

Gets or sets scmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site. Possible values include: '1.0', '1.1', '1.2'

ScmType

Gets or sets SCM type. Possible values include: 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive', 'VSO', 'VSTSRM'

TracingOptions

Gets or sets tracing options.

Use32BitWorkerProcess

Gets or sets &lt;code&gt;true&lt;/code&gt; to use 32-bit worker process; otherwise, &lt;code&gt;false&lt;/code&gt;.

VirtualApplications

Gets or sets virtual applications.

VnetName

Gets or sets virtual Network name.

VnetPrivatePortsCount

Gets or sets the number of private ports assigned to this app. These will be assigned dynamically on runtime.

VnetRouteAllEnabled

Gets or sets virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

WebsiteTimeZone

Gets or sets 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

WebSocketsEnabled

Gets or sets &lt;code&gt;true&lt;/code&gt; if WebSocket is enabled; otherwise, &lt;code&gt;false&lt;/code&gt;.

WindowsFxVersion

Gets or sets xenon App Framework and version

XManagedServiceIdentityId

Gets or sets explicit Managed Service Identity Id

Methods

Validate()

Validate the object.

Applies to