Web Apps - List Configurations Slot

SiteConfigResourceCollection

OK

DefaultErrorResponse

App Service error response.

string

The URL of the API definition.

string

APIM-Api Identifier.

AutoHealActionType

Predefined action to be taken.

AutoHealCustomAction

Custom action to be taken.

string

Minimum time the process must execute before taking the action

string

string

string

string

Executable to be run.

string

Parameters for the executable.

AutoHealActions

Actions to be executed when a rule is triggered.

AutoHealTriggers

Conditions that describe when to execute the auto-heal actions.

integer

A rule based on private bytes.

RequestsBasedTrigger

A rule based on total requests.

SlowRequestsBasedTrigger

A rule based on request execution time.

SlowRequestsBasedTrigger[]

A rule based on multiple Slow Requests Rule with path

StatusCodesBasedTrigger[]

A rule based on status codes.

StatusCodesRangeBasedTrigger[]

A rule based on status codes ranges.

string

Access key for the storage account.

string

Name of the storage account.

string

Path to mount the storage within the site's runtime environment.

AzureStorageProtocol

Mounting protocol to use for the storage account.

string

Name of the file share (container name, for Blob storage).

AzureStorageState

State of the storage account.

AzureStorageType

Type of storage.

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

Connection string value.

string

Name of connection string.

ConnectionStringType

Type of database.

string[]

Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all.

boolean

Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details.

string

string

Error

Error model.

string

Standardized string to programmatically identify the error.

string

Detailed error description and debugging information.

string

Detailed error description and debugging information.

string

Standardized string to programmatically identify the error.

Details[]

Detailed errors.

string

More information to debug error.

string

Detailed error description and debugging information.

string

Detailed error description and debugging information.

RampUpRule[]

List of ramp-up rules.

string

string

string

string

Command-line arguments to be passed to the script processor.

string

Requests with this extension will be handled using the specified FastCGI application.

string

The absolute path to the FastCGI application.

string

string

string

string

Allow or Deny access for this IP range.

string

IP restriction rule description.

object

IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is ..

• If the property is null or empty (default), all hosts(or lack of) are allowed.
• A value is compared using ordinal-ignore-case (excluding port number).
• Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com
• Unicode host names are allowed but are converted to Punycode for matching.

X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is ..

• If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.
• If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.

X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match.

string

IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified.

string

IP restriction rule name.

integer

Priority of IP restriction rule.

string

Subnet mask for the range of IP addresses the restriction is valid for.

integer

(internal) Subnet traffic tag

IpFilterTag

Defines what this IP filter will be used for. This is to support IP filtering on proxies.

string

Virtual network resource id

integer

(internal) Vnet traffic tag

string

string

string

Pair name.

string

Pair value.

string

Resource Id.

string

Kind of resource.

string

Resource Name.

string

Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.

boolean

Gets or sets a flag indicating whether the Push endpoint is enabled.

string

Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.

string

Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.

string

Resource type.

string

Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

string

Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/

integer

Specifies interval in minutes to reevaluate ReroutePercentage.

number

In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.

number

Specifies upper boundary below which ReroutePercentage will stay.

number

Specifies lower boundary above which ReroutePercentage will stay.

string

Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

number

Percentage of the traffic which will be redirected to ActionHostName.

integer

Request Count.

string

Time interval.

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

Resource Id.

string

Kind of resource.

string

Resource Name.

boolean

Flag to use Managed Identity Creds for ACR pull

string

If using user managed identity, the user managed identity ClientId

boolean

true if Always On is enabled; otherwise, false.

ApiDefinitionInfo

Information about the formal API definition for the app.

ApiManagementConfig

Azure API management settings linked to the app.

string

App command line to launch.

NameValuePair[]

Application settings.

boolean

true if Auto Heal is enabled; otherwise, false.

AutoHealRules

Auto Heal rules.

string

Auto-swap slot name.

<string,  AzureStorageInfoValue>

List of Azure Storage Accounts.

ConnStringInfo[]

Connection strings.

CorsSettings

Cross-Origin Resource Sharing (CORS) settings.

string[]

Default documents.

boolean

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

string

Document root.

integer

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

Experiments

This is work around for polymorphic types.

FtpsState

State of FTP / FTPS service

integer

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

boolean

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.

HandlerMapping[]

Handler mappings.

string

Health check path

boolean

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

boolean

true if HTTP logging is enabled; otherwise, false.

IpSecurityRestriction[]

IP security restrictions for main.

DefaultAction

Default action for main access restriction if no rules are matched.

string

Java container.

string

Java container version.

string

Java version.

string

Identity to use for Key Vault Reference authentication.

SiteLimits

Site limits.

string

Linux App Framework and version

SiteLoadBalancing

Site load balancing.

boolean

true to enable local MySQL; otherwise, false.

integer

HTTP logs directory size limit.

SiteMachineKey

Site MachineKey.

ManagedPipelineMode

Managed pipeline mode.

integer

Managed Service Identity Id

NameValuePair[]

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

TlsCipherSuites

The minimum strength TLS cipher suite allowed for an application

SupportedTlsVersions

MinTlsVersion: configures the minimum version of TLS required for SSL requests

integer

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

string

.NET Framework version.

string

Version of Node.js.

integer

Number of workers.

string

Version of PHP.

string

Version of PowerShell.

integer

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

string

Property to allow or block all public traffic.

string

Publishing user name.

PushSettings

Push endpoint settings.

string

Version of Python.

boolean

true if remote debugging is enabled; otherwise, false.

string

Remote debugging version.

boolean

true if request tracing is enabled; otherwise, false.

string

Request tracing expiration time.

IpSecurityRestriction[]

IP security restrictions for scm.

DefaultAction

Default action for scm access restriction if no rules are matched.

boolean

IP security restrictions for scm to use main.

SupportedTlsVersions

ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site

ScmType

SCM type.

string

Tracing options.

boolean

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

VirtualApplication[]

Virtual applications.

string

Virtual Network name.

integer

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

boolean

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

boolean

true if WebSocket is enabled; otherwise, false.

string

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_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones

string

Xenon App Framework and version

integer

Explicit Managed Service Identity Id

string

Resource type.

string

Link to next page of resources.

SiteConfigResource[]

Collection of resources.

integer

Maximum allowed disk size usage in MB.

integer

Maximum allowed memory usage in MB.

number

Maximum allowed CPU usage percentage.

string

string

string

string

string

string

string

string

Algorithm used for decryption.

string

Decryption key.

string

MachineKey validation.

string

Validation key.

integer

Request Count.

string

Request Path.

string

Time interval.

string

Time taken.

integer

Request Count.

string

Request Path

integer

HTTP status code.

integer

Request Sub Status.

string

Time interval.

integer

Win32 error code.

integer

Request Count.

string

string

HTTP status code.

string

Time interval.

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

Physical path.

boolean

true if preloading is enabled; otherwise, false.

VirtualDirectory[]

Virtual directories for virtual application.

string

Virtual path.

string

Physical path.

string

Path to virtual application.