SiteConfig Class

Configuration of an App Service app.

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

Inheritance

Model

SiteConfig

Constructor

SiteConfig(*, number_of_workers: Optional[int] = None, default_documents: Optional[List[str]] = None, net_framework_version: Optional[str] = 'v4.6', php_version: Optional[str] = None, python_version: Optional[str] = None, node_version: Optional[str] = None, power_shell_version: Optional[str] = None, linux_fx_version: Optional[str] = None, windows_fx_version: Optional[str] = None, request_tracing_enabled: Optional[bool] = None, request_tracing_expiration_time: Optional[datetime.datetime] = None, remote_debugging_enabled: Optional[bool] = None, remote_debugging_version: Optional[str] = None, http_logging_enabled: Optional[bool] = None, acr_use_managed_identity_creds: Optional[bool] = None, acr_user_managed_identity_id: Optional[str] = None, logs_directory_size_limit: Optional[int] = None, detailed_error_logging_enabled: Optional[bool] = None, publishing_username: Optional[str] = None, app_settings: Optional[List[azure.mgmt.web.v2019_08_01.models._models_py3.NameValuePair]] = None, connection_strings: Optional[List[azure.mgmt.web.v2019_08_01.models._models_py3.ConnStringInfo]] = None, handler_mappings: Optional[List[azure.mgmt.web.v2019_08_01.models._models_py3.HandlerMapping]] = None, document_root: Optional[str] = None, scm_type: Optional[Union[str, azure.mgmt.web.v2019_08_01.models._web_site_management_client_enums.ScmType]] = None, use32_bit_worker_process: Optional[bool] = None, web_sockets_enabled: Optional[bool] = None, always_on: Optional[bool] = None, java_version: Optional[str] = None, java_container: Optional[str] = None, java_container_version: Optional[str] = None, app_command_line: Optional[str] = None, managed_pipeline_mode: Optional[Union[str, azure.mgmt.web.v2019_08_01.models._web_site_management_client_enums.ManagedPipelineMode]] = None, virtual_applications: Optional[List[azure.mgmt.web.v2019_08_01.models._models_py3.VirtualApplication]] = None, load_balancing: Optional[Union[str, azure.mgmt.web.v2019_08_01.models._web_site_management_client_enums.SiteLoadBalancing]] = None, experiments: Optional[azure.mgmt.web.v2019_08_01.models._models_py3.Experiments] = None, limits: Optional[azure.mgmt.web.v2019_08_01.models._models_py3.SiteLimits] = None, auto_heal_enabled: Optional[bool] = None, auto_heal_rules: Optional[azure.mgmt.web.v2019_08_01.models._models_py3.AutoHealRules] = None, tracing_options: Optional[str] = None, vnet_name: Optional[str] = None, cors: Optional[azure.mgmt.web.v2019_08_01.models._models_py3.CorsSettings] = None, push: Optional[azure.mgmt.web.v2019_08_01.models._models_py3.PushSettings] = None, api_definition: Optional[azure.mgmt.web.v2019_08_01.models._models_py3.ApiDefinitionInfo] = None, api_management_config: Optional[azure.mgmt.web.v2019_08_01.models._models_py3.ApiManagementConfig] = None, auto_swap_slot_name: Optional[str] = None, local_my_sql_enabled: Optional[bool] = False, managed_service_identity_id: Optional[int] = None, x_managed_service_identity_id: Optional[int] = None, ip_security_restrictions: Optional[List[azure.mgmt.web.v2019_08_01.models._models_py3.IpSecurityRestriction]] = None, scm_ip_security_restrictions: Optional[List[azure.mgmt.web.v2019_08_01.models._models_py3.IpSecurityRestriction]] = None, scm_ip_security_restrictions_use_main: Optional[bool] = None, http20_enabled: Optional[bool] = True, min_tls_version: Optional[Union[str, azure.mgmt.web.v2019_08_01.models._web_site_management_client_enums.SupportedTlsVersions]] = None, ftps_state: Optional[Union[str, azure.mgmt.web.v2019_08_01.models._web_site_management_client_enums.FtpsState]] = None, pre_warmed_instance_count: Optional[int] = None, health_check_path: Optional[str] = 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.

power_shell_version

str

Required

Version of PowerShell.

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>.

acr_use_managed_identity_creds

bool

Required

Flag to use Managed Identity Creds for ACR pull.

acr_user_managed_identity_id

str

Required

If using user managed identity, the user managed identity ClientId.

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.

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", "VSTSRM".

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.

api_management_config

ApiManagementConfig

Required

Azure API management settings linked to 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".

pre_warmed_instance_count

int

Required

Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans.

health_check_path

str

Required

Health check path.

Variables

machine_key

SiteMachineKey

Site MachineKey.