SiteConfigResource Class

Web app configuration ARM resource.

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

Inheritance

azure.mgmt.web.v2023_01_01.models._models_py3.ProxyOnlyResource

SiteConfigResource

Constructor

SiteConfigResource(*, kind: str | None = None, 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, power_shell_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, acr_use_managed_identity_creds: bool | None = None, acr_user_managed_identity_id: str | 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, metadata: List[_models.NameValuePair] | 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, vnet_route_all_enabled: bool | None = None, vnet_private_ports_count: int | None = None, cors: _models.CorsSettings | None = None, push: _models.PushSettings | None = None, api_definition: _models.ApiDefinitionInfo | None = None, api_management_config: _models.ApiManagementConfig | 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, key_vault_reference_identity: str | None = None, ip_security_restrictions: List[_models.IpSecurityRestriction] | None = None, ip_security_restrictions_default_action: str | _models.DefaultAction | None = None, scm_ip_security_restrictions: List[_models.IpSecurityRestriction] | None = None, scm_ip_security_restrictions_default_action: str | _models.DefaultAction | None = None, scm_ip_security_restrictions_use_main: bool | None = None, http20_enabled: bool = True, min_tls_version: str | _models.SupportedTlsVersions | None = None, min_tls_cipher_suite: str | _models.TlsCipherSuites | None = None, scm_min_tls_version: str | _models.SupportedTlsVersions | None = None, ftps_state: str | _models.FtpsState | None = None, pre_warmed_instance_count: int | None = None, function_app_scale_limit: int | None = None, elastic_web_app_scale_limit: int | None = None, health_check_path: str | None = None, functions_runtime_scale_monitoring_enabled: bool | None = None, website_time_zone: str | None = None, minimum_elastic_instance_count: int | None = None, azure_storage_accounts: Dict[str, _models.AzureStorageInfoValue] | None = None, public_network_access: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
kind	str Kind of resource.
number_of_workers	int Number of workers.
default_documents	list[str] 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.
power_shell_version	str Version of PowerShell.
linux_fx_version	str Linux App Framework and version.
windows_fx_version	str Xenon App Framework and version.
request_tracing_enabled	bool <code>true</code> if request tracing is enabled; otherwise, <code>false</code>.
request_tracing_expiration_time	datetime Request tracing expiration time.
remote_debugging_enabled	bool <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.
remote_debugging_version	str Remote debugging version.
http_logging_enabled	bool <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.
acr_use_managed_identity_creds	bool Flag to use Managed Identity Creds for ACR pull.
acr_user_managed_identity_id	str If using user managed identity, the user managed identity ClientId.
logs_directory_size_limit	int HTTP logs directory size limit.
detailed_error_logging_enabled	bool <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.
publishing_username	str Publishing user name.
app_settings	list[NameValuePair] Application settings.
metadata	list[NameValuePair] Application metadata. This property cannot be retrieved, since it may contain secrets.
connection_strings	list[ConnStringInfo] Connection strings.
handler_mappings	list[HandlerMapping] Handler mappings.
document_root	str Document root.
scm_type	str or ScmType SCM type. Known values are: "None", "Dropbox", "Tfs", "LocalGit", "GitHub", "CodePlexGit", "CodePlexHg", "BitbucketGit", "BitbucketHg", "ExternalGit", "ExternalHg", "OneDrive", "VSO", and "VSTSRM".
use32_bit_worker_process	bool <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.
web_sockets_enabled	bool <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.
always_on	bool <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	str or ManagedPipelineMode Managed pipeline mode. Known values are: "Integrated" and "Classic".
virtual_applications	list[VirtualApplication] Virtual applications.
load_balancing	str or SiteLoadBalancing Site load balancing. Known values are: "WeightedRoundRobin", "LeastRequests", "LeastResponseTime", "WeightedTotalTraffic", "RequestHash", and "PerSiteRoundRobin".
experiments	Experiments This is work around for polymorphic types.
limits	SiteLimits Site limits.
auto_heal_enabled	bool <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.
auto_heal_rules	AutoHealRules Auto Heal rules.
tracing_options	str Tracing options.
vnet_name	str Virtual Network name.
vnet_route_all_enabled	bool Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.
vnet_private_ports_count	int The number of private ports assigned to this app. These will be assigned dynamically on runtime.
cors	CorsSettings Cross-Origin Resource Sharing (CORS) settings.
push	PushSettings Push endpoint settings.
api_definition	ApiDefinitionInfo Information about the formal API definition for the app.
api_management_config	ApiManagementConfig Azure API management settings linked to the app.
auto_swap_slot_name	str Auto-swap slot name.
local_my_sql_enabled	bool <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.
key_vault_reference_identity	str Identity to use for Key Vault Reference authentication.
ip_security_restrictions	list[IpSecurityRestriction] IP security restrictions for main.
ip_security_restrictions_default_action	str or DefaultAction Default action for main access restriction if no rules are matched. Known values are: "Allow" and "Deny".
scm_ip_security_restrictions	list[IpSecurityRestriction] IP security restrictions for scm.
scm_ip_security_restrictions_default_action	str or DefaultAction Default action for scm access restriction if no rules are matched. Known values are: "Allow" and "Deny".
scm_ip_security_restrictions_use_main	bool IP security restrictions for scm to use main.
http20_enabled	bool Http20Enabled: configures a web site to allow clients to connect over http2.0. Default value: True
min_tls_version	str or SupportedTlsVersions MinTlsVersion: configures the minimum version of TLS required for SSL requests. Known values are: "1.0", "1.1", and "1.2".
min_tls_cipher_suite	str or TlsCipherSuites 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".
scm_min_tls_version	str or SupportedTlsVersions ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site. Known values are: "1.0", "1.1", and "1.2".
ftps_state	str or FtpsState State of FTP / FTPS service. Known values are: "AllAllowed", "FtpsOnly", and "Disabled".
pre_warmed_instance_count	int Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans.
function_app_scale_limit	int Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans.
elastic_web_app_scale_limit	int Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code>.
health_check_path	str Health check path.
functions_runtime_scale_monitoring_enabled	bool 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.
website_time_zone	str 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.
minimum_elastic_instance_count	int Number of minimum instance count for a site This setting only applies to the Elastic Plans.
azure_storage_accounts	dict[str, AzureStorageInfoValue] List of Azure Storage Accounts.
public_network_access	str Property to allow or block all public traffic.

Variables

Name	Description
id	str Resource Id.
name	str Resource Name.
kind	str Kind of resource.
type	str Resource type.
number_of_workers	int Number of workers.
default_documents	list[str] 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.
power_shell_version	str Version of PowerShell.
linux_fx_version	str Linux App Framework and version.
windows_fx_version	str Xenon App Framework and version.
request_tracing_enabled	bool <code>true</code> if request tracing is enabled; otherwise, <code>false</code>.
request_tracing_expiration_time	datetime Request tracing expiration time.
remote_debugging_enabled	bool <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.
remote_debugging_version	str Remote debugging version.
http_logging_enabled	bool <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.
acr_use_managed_identity_creds	bool Flag to use Managed Identity Creds for ACR pull.
acr_user_managed_identity_id	str If using user managed identity, the user managed identity ClientId.
logs_directory_size_limit	int HTTP logs directory size limit.
detailed_error_logging_enabled	bool <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.
publishing_username	str Publishing user name.
app_settings	list[NameValuePair] Application settings.
metadata	list[NameValuePair] Application metadata. This property cannot be retrieved, since it may contain secrets.
connection_strings	list[ConnStringInfo] Connection strings.
machine_key	SiteMachineKey Site MachineKey.
handler_mappings	list[HandlerMapping] Handler mappings.
document_root	str Document root.
scm_type	str or ScmType SCM type. Known values are: "None", "Dropbox", "Tfs", "LocalGit", "GitHub", "CodePlexGit", "CodePlexHg", "BitbucketGit", "BitbucketHg", "ExternalGit", "ExternalHg", "OneDrive", "VSO", and "VSTSRM".
use32_bit_worker_process	bool <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.
web_sockets_enabled	bool <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.
always_on	bool <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	str or ManagedPipelineMode Managed pipeline mode. Known values are: "Integrated" and "Classic".
virtual_applications	list[VirtualApplication] Virtual applications.
load_balancing	str or SiteLoadBalancing Site load balancing. Known values are: "WeightedRoundRobin", "LeastRequests", "LeastResponseTime", "WeightedTotalTraffic", "RequestHash", and "PerSiteRoundRobin".
experiments	Experiments This is work around for polymorphic types.
limits	SiteLimits Site limits.
auto_heal_enabled	bool <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.
auto_heal_rules	AutoHealRules Auto Heal rules.
tracing_options	str Tracing options.
vnet_name	str Virtual Network name.
vnet_route_all_enabled	bool Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.
vnet_private_ports_count	int The number of private ports assigned to this app. These will be assigned dynamically on runtime.
cors	CorsSettings Cross-Origin Resource Sharing (CORS) settings.
push	PushSettings Push endpoint settings.
api_definition	ApiDefinitionInfo Information about the formal API definition for the app.
api_management_config	ApiManagementConfig Azure API management settings linked to the app.
auto_swap_slot_name	str Auto-swap slot name.
local_my_sql_enabled	bool <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.
key_vault_reference_identity	str Identity to use for Key Vault Reference authentication.
ip_security_restrictions	list[IpSecurityRestriction] IP security restrictions for main.
ip_security_restrictions_default_action	str or DefaultAction Default action for main access restriction if no rules are matched. Known values are: "Allow" and "Deny".
scm_ip_security_restrictions	list[IpSecurityRestriction] IP security restrictions for scm.
scm_ip_security_restrictions_default_action	str or DefaultAction Default action for scm access restriction if no rules are matched. Known values are: "Allow" and "Deny".
scm_ip_security_restrictions_use_main	bool IP security restrictions for scm to use main.
http20_enabled	bool Http20Enabled: configures a web site to allow clients to connect over http2.0.
min_tls_version	str or SupportedTlsVersions MinTlsVersion: configures the minimum version of TLS required for SSL requests. Known values are: "1.0", "1.1", and "1.2".
min_tls_cipher_suite	str or TlsCipherSuites 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".
scm_min_tls_version	str or SupportedTlsVersions ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site. Known values are: "1.0", "1.1", and "1.2".
ftps_state	str or FtpsState State of FTP / FTPS service. Known values are: "AllAllowed", "FtpsOnly", and "Disabled".
pre_warmed_instance_count	int Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans.
function_app_scale_limit	int Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans.
elastic_web_app_scale_limit	int Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code>.
health_check_path	str Health check path.
functions_runtime_scale_monitoring_enabled	bool 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.
website_time_zone	str 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.
minimum_elastic_instance_count	int Number of minimum instance count for a site This setting only applies to the Elastic Plans.
azure_storage_accounts	dict[str, AzureStorageInfoValue] List of Azure Storage Accounts.
public_network_access	str Property to allow or block all public traffic.