SiteConfig Class

Configuration of an App Service app.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.web._serialization.Model
SiteConfig

Constructor

SiteConfig(*, number_of_workers: int | None = None, default_documents: List[str] | None = None, net_framework_version: str = 'v4.6', php_version: str | None = None, python_version: str | None = None, node_version: str | None = None, linux_fx_version: str | None = None, windows_fx_version: str | None = None, request_tracing_enabled: bool | None = None, request_tracing_expiration_time: datetime | None = None, remote_debugging_enabled: bool | None = None, remote_debugging_version: str | None = None, http_logging_enabled: bool | None = None, logs_directory_size_limit: int | None = None, detailed_error_logging_enabled: bool | None = None, publishing_username: str | None = None, app_settings: List[_models.NameValuePair] | None = None, azure_storage_accounts: Dict[str, _models.AzureStorageInfoValue] | None = None, connection_strings: List[_models.ConnStringInfo] | None = None, handler_mappings: List[_models.HandlerMapping] | None = None, document_root: str | None = None, scm_type: str | _models.ScmType | None = None, use32_bit_worker_process: bool | None = None, web_sockets_enabled: bool | None = None, always_on: bool | None = None, java_version: str | None = None, java_container: str | None = None, java_container_version: str | None = None, app_command_line: str | None = None, managed_pipeline_mode: str | _models.ManagedPipelineMode | None = None, virtual_applications: List[_models.VirtualApplication] | None = None, load_balancing: str | _models.SiteLoadBalancing | None = None, experiments: _models.Experiments | None = None, limits: _models.SiteLimits | None = None, auto_heal_enabled: bool | None = None, auto_heal_rules: _models.AutoHealRules | None = None, tracing_options: str | None = None, vnet_name: str | None = None, cors: _models.CorsSettings | None = None, push: _models.PushSettings | None = None, api_definition: _models.ApiDefinitionInfo | None = None, auto_swap_slot_name: str | None = None, local_my_sql_enabled: bool = False, managed_service_identity_id: int | None = None, x_managed_service_identity_id: int | None = None, ip_security_restrictions: List[_models.IpSecurityRestriction] | None = None, scm_ip_security_restrictions: List[_models.IpSecurityRestriction] | None = None, scm_ip_security_restrictions_use_main: bool | None = None, http20_enabled: bool = True, min_tls_version: str | _models.SupportedTlsVersions | None = None, ftps_state: str | _models.FtpsState | None = None, reserved_instance_count: int | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
number_of_workers
int

Number of workers.

default_documents

Default documents.

net_framework_version
str

.NET Framework version.

Default value: v4.6
php_version
str

Version of PHP.

python_version
str

Version of Python.

node_version
str

Version of Node.js.

linux_fx_version
str

Linux App Framework and version.

windows_fx_version
str

Xenon App Framework and version.

request_tracing_enabled

<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.

request_tracing_expiration_time

Request tracing expiration time.

remote_debugging_enabled

<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.

remote_debugging_version
str

Remote debugging version.

http_logging_enabled

<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.

logs_directory_size_limit
int

HTTP logs directory size limit.

detailed_error_logging_enabled

<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.

publishing_username
str

Publishing user name.

app_settings

Application settings.

azure_storage_accounts

User-provided Azure storage accounts.

connection_strings

Connection strings.

handler_mappings

Handler mappings.

document_root
str

Document root.

scm_type

SCM type. Known values are: "None", "Dropbox", "Tfs", "LocalGit", "GitHub", "CodePlexGit", "CodePlexHg", "BitbucketGit", "BitbucketHg", "ExternalGit", "ExternalHg", "OneDrive", and "VSO".

use32_bit_worker_process

<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.

web_sockets_enabled

<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.

always_on

<code>true</code> if Always On is enabled; otherwise, <code>false</code>.

java_version
str

Java version.

java_container
str

Java container.

java_container_version
str

Java container version.

app_command_line
str

App command line to launch.

managed_pipeline_mode

Managed pipeline mode. Known values are: "Integrated" and "Classic".

virtual_applications

Virtual applications.

load_balancing

Site load balancing. Known values are: "WeightedRoundRobin", "LeastRequests", "LeastResponseTime", "WeightedTotalTraffic", and "RequestHash".

experiments

This is work around for polymorphic types.

limits

Site limits.

auto_heal_enabled

<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.

auto_heal_rules

Auto Heal rules.

tracing_options
str

Tracing options.

vnet_name
str

Virtual Network name.

cors

Cross-Origin Resource Sharing (CORS) settings.

push

Push endpoint settings.

api_definition

Information about the formal API definition for the app.

auto_swap_slot_name
str

Auto-swap slot name.

local_my_sql_enabled

<code>true</code> to enable local MySQL; otherwise, <code>false</code>.

managed_service_identity_id
int

Managed Service Identity Id.

x_managed_service_identity_id
int

Explicit Managed Service Identity Id.

ip_security_restrictions

IP security restrictions for main.

scm_ip_security_restrictions

IP security restrictions for scm.

scm_ip_security_restrictions_use_main

IP security restrictions for scm to use main.

http20_enabled

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

Default value: True
min_tls_version

MinTlsVersion: configures the minimum version of TLS required for SSL requests. Known values are: "1.0", "1.1", and "1.2".

ftps_state

State of FTP / FTPS service. Known values are: "AllAllowed", "FtpsOnly", and "Disabled".

reserved_instance_count
int

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

Variables

Name Description
number_of_workers
int

Number of workers.

default_documents

Default documents.

net_framework_version
str

.NET Framework version.

php_version
str

Version of PHP.

python_version
str

Version of Python.

node_version
str

Version of Node.js.

linux_fx_version
str

Linux App Framework and version.

windows_fx_version
str

Xenon App Framework and version.

request_tracing_enabled

<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.

request_tracing_expiration_time

Request tracing expiration time.

remote_debugging_enabled

<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.

remote_debugging_version
str

Remote debugging version.

http_logging_enabled

<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.

logs_directory_size_limit
int

HTTP logs directory size limit.

detailed_error_logging_enabled

<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.

publishing_username
str

Publishing user name.

app_settings

Application settings.

azure_storage_accounts

User-provided Azure storage accounts.

connection_strings

Connection strings.

machine_key

Site MachineKey.

handler_mappings

Handler mappings.

document_root
str

Document root.

scm_type

SCM type. Known values are: "None", "Dropbox", "Tfs", "LocalGit", "GitHub", "CodePlexGit", "CodePlexHg", "BitbucketGit", "BitbucketHg", "ExternalGit", "ExternalHg", "OneDrive", and "VSO".

use32_bit_worker_process

<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.

web_sockets_enabled

<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.

always_on

<code>true</code> if Always On is enabled; otherwise, <code>false</code>.

java_version
str

Java version.

java_container
str

Java container.

java_container_version
str

Java container version.

app_command_line
str

App command line to launch.

managed_pipeline_mode

Managed pipeline mode. Known values are: "Integrated" and "Classic".

virtual_applications

Virtual applications.

load_balancing

Site load balancing. Known values are: "WeightedRoundRobin", "LeastRequests", "LeastResponseTime", "WeightedTotalTraffic", and "RequestHash".

experiments

This is work around for polymorphic types.

limits

Site limits.

auto_heal_enabled

<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.

auto_heal_rules

Auto Heal rules.

tracing_options
str

Tracing options.

vnet_name
str

Virtual Network name.

cors

Cross-Origin Resource Sharing (CORS) settings.

push

Push endpoint settings.

api_definition

Information about the formal API definition for the app.

auto_swap_slot_name
str

Auto-swap slot name.

local_my_sql_enabled

<code>true</code> to enable local MySQL; otherwise, <code>false</code>.

managed_service_identity_id
int

Managed Service Identity Id.

x_managed_service_identity_id
int

Explicit Managed Service Identity Id.

ip_security_restrictions

IP security restrictions for main.

scm_ip_security_restrictions

IP security restrictions for scm.

scm_ip_security_restrictions_use_main

IP security restrictions for scm to use main.

http20_enabled

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

min_tls_version

MinTlsVersion: configures the minimum version of TLS required for SSL requests. Known values are: "1.0", "1.1", and "1.2".

ftps_state

State of FTP / FTPS service. Known values are: "AllAllowed", "FtpsOnly", and "Disabled".

reserved_instance_count
int

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