SiteConfig Class

Configuration of an App Service app.

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

Inheritance
SiteConfig

Constructor

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

Parameters

number_of_workers
int
Required

Number of workers.

default_documents
list[str]
Required

Default documents.

net_framework_version
str
Required

.NET Framework version.

php_version
str
Required

Version of PHP.

python_version
str
Required

Version of Python.

node_version
str
Required

Version of Node.js.

linux_fx_version
str
Required

Linux App Framework and version.

windows_fx_version
str
Required

Xenon App Framework and version.

request_tracing_enabled
bool
Required

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

request_tracing_expiration_time
datetime
Required

Request tracing expiration time.

remote_debugging_enabled
bool
Required

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

remote_debugging_version
str
Required

Remote debugging version.

http_logging_enabled
bool
Required

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

logs_directory_size_limit
int
Required

HTTP logs directory size limit.

detailed_error_logging_enabled
bool
Required

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

publishing_username
str
Required

Publishing user name.

app_settings
list[NameValuePair]
Required

Application settings.

azure_storage_accounts
dict[<xref:str,azure.mgmt.web.v2018_02_01.models.AzureStorageInfoValue>]
Required

User-provided Azure storage accounts.

connection_strings
list[ConnStringInfo]
Required

Connection strings.

handler_mappings
list[HandlerMapping]
Required

Handler mappings.

document_root
str
Required

Document root.

scm_type
str or ScmType
Required

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

use32_bit_worker_process
bool
Required

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

web_sockets_enabled
bool
Required

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

always_on
bool
Required

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

java_version
str
Required

Java version.

java_container
str
Required

Java container.

java_container_version
str
Required

Java container version.

app_command_line
str
Required

App command line to launch.

managed_pipeline_mode
str or ManagedPipelineMode
Required

Managed pipeline mode. Possible values include: "Integrated", "Classic".

virtual_applications
list[VirtualApplication]
Required

Virtual applications.

load_balancing
str or SiteLoadBalancing
Required

Site load balancing. Possible values include: "WeightedRoundRobin", "LeastRequests", "LeastResponseTime", "WeightedTotalTraffic", "RequestHash".

experiments
Experiments
Required

This is work around for polymorphic types.

limits
SiteLimits
Required

Site limits.

auto_heal_enabled
bool
Required

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

auto_heal_rules
AutoHealRules
Required

Auto Heal rules.

tracing_options
str
Required

Tracing options.

vnet_name
str
Required

Virtual Network name.

cors
CorsSettings
Required

Cross-Origin Resource Sharing (CORS) settings.

push
PushSettings
Required

Push endpoint settings.

api_definition
ApiDefinitionInfo
Required

Information about the formal API definition for the app.

auto_swap_slot_name
str
Required

Auto-swap slot name.

local_my_sql_enabled
bool
Required

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

managed_service_identity_id
int
Required

Managed Service Identity Id.

x_managed_service_identity_id
int
Required

Explicit Managed Service Identity Id.

ip_security_restrictions
list[IpSecurityRestriction]
Required

IP security restrictions for main.

scm_ip_security_restrictions
list[IpSecurityRestriction]
Required

IP security restrictions for scm.

scm_ip_security_restrictions_use_main
bool
Required

IP security restrictions for scm to use main.

http20_enabled
bool
Required

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

min_tls_version
str or SupportedTlsVersions
Required

MinTlsVersion: configures the minimum version of TLS required for SSL requests. Possible values include: "1.0", "1.1", "1.2".

ftps_state
str or FtpsState
Required

State of FTP / FTPS service. Possible values include: "AllAllowed", "FtpsOnly", "Disabled".

reserved_instance_count
int
Required

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

Variables

machine_key
SiteMachineKey

Site MachineKey.