SiteConfig Class

Flag to use Managed Identity Creds for ACR pull.

acr_use_managed_identity_creds: bool | None

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

acr_user_managed_identity_id: str | None

true if Always On is enabled; otherwise, false.

always_on: bool | None

Information about the formal API definition for the app.

api_definition: _models.ApiDefinitionInfo | None

Azure API management settings linked to the app.

api_management_config: _models.ApiManagementConfig | None

App command line to launch.

app_command_line: str | None

Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information.

app_settings: list['_models.NameValuePair'] | None

true if Auto Heal is enabled; otherwise, false.

auto_heal_enabled: bool | None

Auto Heal rules.

auto_heal_rules: _models.AutoHealRules | None

Auto-swap slot name.

auto_swap_slot_name: str | None

List of Azure Storage Accounts.

azure_storage_accounts: dict[str, '_models.AzureStorageInfoValue'] | None

Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information.

connection_strings: list['_models.ConnStringInfo'] | None

Cross-Origin Resource Sharing (CORS) settings.

cors: _models.CorsSettings | None

Default documents.

default_documents: list[str] | None

true if detailed error logging is enabled; otherwise, false.

detailed_error_logging_enabled: bool | None

Document root.

document_root: str | None

Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true.

elastic_web_app_scale_limit: int | None

This is work around for polymorphic types.

experiments: _models.Experiments | None

"AllAllowed", "FtpsOnly", and "Disabled".

ftps_state: str | _models.FtpsState | None

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

function_app_scale_limit: int | None

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.

functions_runtime_scale_monitoring_enabled: bool | None

Handler mappings.

handler_mappings: list['_models.HandlerMapping'] | None

Health check path.

health_check_path: str | None

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

http20_enabled: bool | None

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.

http20_proxy_flag: int | None

true if HTTP logging is enabled; otherwise, false.

http_logging_enabled: bool | None

IP security restrictions for main.

ip_security_restrictions: list['_models.IpSecurityRestriction'] | None

"Allow" and "Deny".

ip_security_restrictions_default_action: str | _models.DefaultAction | None

Java container.

java_container: str | None

Java container version.

java_container_version: str | None

Java version.

java_version: str | None

Identity to use for Key Vault Reference authentication.

key_vault_reference_identity: str | None

Site limits.

limits: _models.SiteLimits | None

Linux App Framework and version.

linux_fx_version: str | None

"WeightedRoundRobin", "LeastRequests", "LeastResponseTime", "WeightedTotalTraffic", "RequestHash", "PerSiteRoundRobin", and "LeastRequestsWithTieBreaker".

load_balancing: str | _models.SiteLoadBalancing | None

true to enable local MySQL; otherwise, false.

local_my_sql_enabled: bool | None

HTTP logs directory size limit.

logs_directory_size_limit: int | None

Site MachineKey.

machine_key: _models.SiteMachineKey | None

"Integrated" and "Classic".

managed_pipeline_mode: str | _models.ManagedPipelineMode | None

Managed Service Identity Id.

managed_service_identity_id: int | None

Application metadata. This property cannot be retrieved, since it may contain secrets.

metadata: list['_models.NameValuePair'] | None

The minimum strength TLS cipher suite allowed for an application. Known values are: "TLS_AES_256_GCM_SHA384", "TLS_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_256_GCM_SHA384", "TLS_RSA_WITH_AES_128_GCM_SHA256", "TLS_RSA_WITH_AES_256_CBC_SHA256", "TLS_RSA_WITH_AES_128_CBC_SHA256", "TLS_RSA_WITH_AES_256_CBC_SHA", and "TLS_RSA_WITH_AES_128_CBC_SHA".

min_tls_cipher_suite: str | _models.TlsCipherSuites | None

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

min_tls_version: str | _models.SupportedTlsVersions | None

Number of minimum instance count for a site This setting only applies to the Elastic Plans.

minimum_elastic_instance_count: int | None

.NET Framework version.

net_framework_version: str | None

Version of Node.js.

node_version: str | None

Number of workers.

number_of_workers: int | None

Version of PHP.

php_version: str | None

Version of PowerShell.

power_shell_version: str | None

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

pre_warmed_instance_count: int | None

Property to allow or block all public traffic.

public_network_access: str | None

Publishing user name.

publishing_username: str | None

Push endpoint settings.

push: _models.PushSettings | None

Version of Python.

python_version: str | None

true if remote debugging is enabled; otherwise, false.

remote_debugging_enabled: bool | None

Remote debugging version.

remote_debugging_version: str | None

true if request tracing is enabled; otherwise, false.

request_tracing_enabled: bool | None

Request tracing expiration time.

request_tracing_expiration_time: datetime | None

IP security restrictions for scm.

scm_ip_security_restrictions: list['_models.IpSecurityRestriction'] | None

"Allow" and "Deny".

scm_ip_security_restrictions_default_action: str | _models.DefaultAction | None

IP security restrictions for scm to use main.

scm_ip_security_restrictions_use_main: bool | None

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

scm_min_tls_version: str | _models.SupportedTlsVersions | None

"None", "Dropbox", "Tfs", "LocalGit", "GitHub", "CodePlexGit", "CodePlexHg", "BitbucketGit", "BitbucketHg", "ExternalGit", "ExternalHg", "OneDrive", "VSO", and "VSTSRM".

scm_type: str | _models.ScmType | None

Tracing options.

tracing_options: str | None

true to use 32-bit worker process; otherwise, false.

use32_bit_worker_process: bool | None

Virtual applications.

virtual_applications: list['_models.VirtualApplication'] | None

Virtual Network name.

vnet_name: str | None

The number of private ports assigned to this app. These will be assigned dynamically on runtime.

vnet_private_ports_count: int | None

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

vnet_route_all_enabled: bool | None

true if WebSocket is enabled; otherwise, false.

web_sockets_enabled: bool | None

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_MACHINESOFTWAREMicrosoftWindows NTCurrentVersionTime Zones.

website_time_zone: str | None

Xenon App Framework and version.

windows_fx_version: str | None

Explicit Managed Service Identity Id.

x_managed_service_identity_id: int | None