Web Apps - List

WebAppCollection

OK

DefaultErrorResponse

App Service error response.

string

The URL of the API definition.

string

APIM-Api Identifier.

string

Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type.

AuthenticationType

Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString.

string

Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type.

AutoHealActionType

Predefined action to be taken.

AutoHealCustomAction

Custom action to be taken.

string

Minimum time the process must execute before taking the action

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 (int32)

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.

object

Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.

boolean

true to clone custom hostnames from source app; otherwise, false.

boolean

true to clone source control from source app; otherwise, false.

boolean

true to configure load balancing for source and destination app.

string (uuid)

Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.

string

App Service Environment.

boolean

true to overwrite destination app; otherwise, false.

string

ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.

string

Location of source app ex: West US or North Europe

string

ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.

string

Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.

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

Dapr application identifier

integer (int32)

Tells Dapr which port your application is listening on

boolean

Enables API logging for the Dapr sidecar

boolean

Boolean indicating if the Dapr side car is enabled

integer (int32)

Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB.

integer (int32)

Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.

daprLogLevel

Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.

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

Name of extended location.

string

Type of extended location.

FunctionsDeployment

Function app deployment configuration.

FunctionsRuntime

Function app runtime settings.

FunctionsScaleAndConcurrency

Function app scale and concurrency settings.

integer (int32)

Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready.

string

Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready.

Storage

Storage for deployed package used by the function app.

RuntimeName

Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom

string

Function app runtime version. Example: 8 (for dotnet-isolated)

FunctionsAlwaysReadyConfig[]

'Always Ready' configuration for the function app.

integer (int32)

Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally.

integer (int32)

The maximum number of instances for the function app.

Triggers

Scale and concurrency settings for the function app triggers.

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

Resource ID of the App Service Environment.

string

Name of the App Service Environment.

string

Resource type of the App Service Environment.

HostType

Indicates whether the hostname is a standard or repository hostname.

string

Hostname.

SslState

SSL type.

string

SSL certificate thumbprint.

boolean

Set to true to update existing hostname.

string

Virtual IP address assigned to the hostname if IP based SSL is enabled.

integer (int32)

The maximum number of concurrent HTTP trigger invocations per instance.

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 (int32)

Priority of IP restriction rule.

string

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

integer (int32)

(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 (int32)

(internal) Vnet traffic tag

string

Principal Id of managed service identity.

string

Tenant of managed service identity.

ManagedServiceIdentityType

Type of managed service identity.

<string,  userAssignedIdentity>

The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

string

Pair name.

string

Pair value.

boolean

Enables all other routing options defined in OutboundVnetRouting if this setting is set to true.

boolean

This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled.

boolean

Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled

boolean

Enables accessing content over virtual network. Previously called VnetContentShareEnabled

boolean

Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled.

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.

integer (int32)

Specifies interval in minutes to reevaluate ReroutePercentage.

number (double)

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 (double)

Specifies upper boundary below which ReroutePercentage will stay.

number (double)

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 (double)

Percentage of the traffic which will be redirected to ActionHostName.

integer (int32)

Request Count.

string

Time interval.

number (double)

Required CPU in cores, e.g. 0.5

string

Required memory, e.g. "1Gi"

ExtendedLocation

Extended Location.

string

Resource Id.

ManagedServiceIdentity

Managed service identity.

string

Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.

string

Resource Location.

string

Resource Name.

autoGeneratedDomainNameLabelScope

Specifies the scope of uniqueness for the default hostname during resource creation

SiteAvailabilityState

Management information availability state for the app.

boolean

true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

boolean

true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false.

boolean

true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false.

boolean

true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

string

client certificate authentication comma-separated exclusion paths

ClientCertMode

This composes with ClientCertEnabled setting.

• ClientCertEnabled: false means ClientCert is ignored.
• ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
• ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.

CloningInfo

If specified during app creation, the app is cloned from a source app.

integer (int32)

Size of the function container.

string

Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

integer (int32)

Maximum allowed daily memory-time quota (applicable on dynamic apps only).

DaprConfig

Dapr configuration of the app.

string

Default hostname of the app. Read-only.

SiteDnsConfig

Property to configure various DNS related settings for a site.

boolean

true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

string[]

Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.

boolean

Whether to use end to end encryption between the FrontEnd and the Worker

FunctionAppConfig

Configuration specific of the Azure Function app.

HostNameSslState[]

Hostname SSL states are used to manage the SSL bindings for app's hostnames.

string[]

Hostnames associated with the app.

boolean

true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

HostingEnvironmentProfile

App Service Environment to use for the app.

boolean

HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

boolean

Hyper-V sandbox.

string (uuid)

Specifies an operation id if this site has a pending operation.

IPMode

Specifies the IP mode of the app.

boolean

true if the app is a default container; otherwise, false.

boolean

Obsolete: Hyper-V sandbox.

string

Identity to use for Key Vault Reference authentication.

string (date-time)

Last time the app was modified, in UTC. Read-only.

string

Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}

integer (int32)

Maximum number of workers. This only applies to Functions container.

string

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.

OutboundVnetRouting

Property to configure various outbound traffic routing options over virtual network for a site

string

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.

string

Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.

RedundancyMode

Site redundancy mode

string

Name of the repository site.

boolean

true if reserved; otherwise, false.

ResourceConfig

Function app resource requirements.

string

Name of the resource group the app belongs to. Read-only.

boolean

true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

string

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

SiteConfig

Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information.

string

Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2

SlotSwapStatus

Status of the last deployment slot swap operation.

boolean

Whether to enable ssh access.

string

Current state of the app.

boolean

Checks if Customer provided storage account is required

string (date-time)

App suspended till in case memory-time quota is exceeded.

string

Specifies which deployment slot this app will swap into. Read-only.

string[]

Azure Traffic Manager hostnames associated with the app. Read-only.

UsageState

State indicating whether the app has exceeded its quota usage. Read-only.

string

Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

string

Workload profile name for function app to execute on.

object

Resource tags.

string

Resource type.

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. This property is not returned in response to normal create and read requests since it may contain sensitive information.

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. This property is not returned in response to normal create and read requests since it may contain sensitive information.

CorsSettings

Cross-Origin Resource Sharing (CORS) settings.

string[]

Default documents.

boolean

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

string

Document root.

integer (int32)

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 (int32)

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

integer (int32)

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

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 (int32)

HTTP logs directory size limit.

SiteMachineKey

Site MachineKey.

ManagedPipelineMode

Managed pipeline mode.

integer (int32)

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 (int32)

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 (int32)

Number of workers.

string

Version of PHP.

string

Version of PowerShell.

integer (int32)

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 (date-time)

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 (int32)

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 (int32)

Explicit Managed Service Identity Id

string

Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting.

boolean

Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only.

integer (int32)

Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled.

integer (int32)

Total number of retries for dns lookup. Allowed range: 1-5. Default is 3.

integer (int32)

Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3.

string[]

List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set.

integer (int64)

Maximum allowed disk size usage in MB.

integer (int64)

Maximum allowed memory usage in MB.

number (double)

Maximum allowed CPU usage percentage.

string

Algorithm used for decryption.

string

Decryption key.

string

MachineKey validation.

string

Validation key.

string

The destination slot of the last swap operation.

string

The source slot of the last swap operation.

string (date-time)

The time the last successful slot swap completed.

integer (int32)

Request Count.

string

Request Path.

string

Time interval.

string

Time taken.

integer (int32)

Request Count.

string

Request Path

integer (int32)

HTTP status code.

integer (int32)

Request Sub Status.

string

Time interval.

integer (int32)

Win32 error code.

integer (int32)

Request Count.

string

string

HTTP status code.

string

Time interval.

Authentication

Authentication method to access the storage account for deployment.

FunctionsDeploymentStorageType

Property to select Azure Storage type. Available options: blobContainer.

string (uri)

Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://<storageAccountName>.blob.core.windows.net/<containerName>.

Http

Scale and concurrency settings for the HTTP trigger.

string

Client Id of user assigned identity

string

Principal Id of user assigned identity

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.

string

Link to next page of resources.

Site[]

Collection of resources.