Web Apps - List
Description for Get all apps for a subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites?api-version=2023-12-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
api-version
|
query | True |
string |
API Version |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
App Service error response. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
List Web apps for subscription
Sample request
Sample response
{
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141",
"name": "sitef6141",
"type": "Microsoft.Web/sites",
"kind": "app",
"location": "East US",
"properties": {
"state": "Running",
"hostNames": [
"sitef6141.azurewebsites.net"
],
"repositorySiteName": "sitef6141",
"usageState": "Normal",
"enabled": true,
"enabledHostNames": [
"sitef6141.azurewebsites.net",
"sitef6141.scm.azurewebsites.net"
],
"availabilityState": "Normal",
"hostNameSslStates": [
{
"name": "sitef6141.azurewebsites.net",
"sslState": "Disabled",
"hostType": "Standard"
},
{
"name": "sitef6141.scm.azurewebsites.net",
"sslState": "Disabled",
"hostType": "Repository"
}
],
"serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp",
"reserved": false,
"isXenon": false,
"hyperV": false,
"lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z",
"vnetRouteAllEnabled": false,
"vnetImagePullEnabled": false,
"vnetContentShareEnabled": false,
"siteConfig": {
"numberOfWorkers": 1,
"defaultDocuments": [
"Default.htm",
"Default.html",
"Default.asp",
"index.htm",
"index.html",
"iisstart.htm",
"default.aspx",
"index.php",
"hostingstart.html"
],
"netFrameworkVersion": "v4.0",
"phpVersion": "5.6",
"pythonVersion": "",
"nodeVersion": "",
"powerShellVersion": "",
"linuxFxVersion": "",
"requestTracingEnabled": false,
"remoteDebuggingEnabled": false,
"httpLoggingEnabled": false,
"acrUseManagedIdentityCreds": false,
"logsDirectorySizeLimit": 35,
"detailedErrorLoggingEnabled": false,
"use32BitWorkerProcess": true,
"webSocketsEnabled": false,
"alwaysOn": false,
"appCommandLine": "",
"managedPipelineMode": "Integrated",
"virtualApplications": [
{
"virtualPath": "/",
"physicalPath": "site\\wwwroot",
"preloadEnabled": false
}
],
"loadBalancing": "LeastRequests",
"autoHealEnabled": false,
"vnetName": "",
"vnetRouteAllEnabled": false,
"vnetPrivatePortsCount": 0,
"http20Enabled": false,
"minTlsVersion": "1.2",
"scmMinTlsVersion": "1.2",
"ftpsState": "AllAllowed",
"functionAppScaleLimit": 0,
"functionsRuntimeScaleMonitoringEnabled": false,
"minimumElasticInstanceCount": 0,
"azureStorageAccounts": {}
},
"scmSiteAlsoStopped": false,
"clientAffinityEnabled": true,
"clientCertEnabled": false,
"clientCertMode": "Required",
"hostNamesDisabled": false,
"customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153",
"outboundIpAddresses": "70.37.102.201,20.225.43.144",
"possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188",
"containerSize": 0,
"dailyMemoryTimeQuota": 0,
"resourceGroup": "testrg123",
"defaultHostName": "sitef6141.azurewebsites.net",
"httpsOnly": false,
"redundancyMode": "None",
"storageAccountRequired": false,
"keyVaultReferenceIdentity": "SystemAssigned",
"workloadProfileName": "myd4wp",
"resourceConfig": {
"cpu": 1,
"memory": "2.0Gi"
}
}
},
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef7252",
"name": "sitef7252",
"type": "Microsoft.Web/sites",
"kind": "app",
"location": "East US",
"properties": {
"state": "Running",
"hostNames": [
"sitef7252.azurewebsites.net"
],
"repositorySiteName": "sitef7252",
"usageState": "Normal",
"enabled": true,
"enabledHostNames": [
"sitef7252.azurewebsites.net",
"sitef7252.scm.azurewebsites.net"
],
"availabilityState": "Normal",
"hostNameSslStates": [
{
"name": "sitef7252.azurewebsites.net",
"sslState": "Disabled",
"hostType": "Standard"
},
{
"name": "sitef7252.scm.azurewebsites.net",
"sslState": "Disabled",
"hostType": "Repository"
}
],
"serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp",
"reserved": false,
"isXenon": false,
"hyperV": false,
"lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z",
"vnetRouteAllEnabled": false,
"vnetImagePullEnabled": false,
"vnetContentShareEnabled": false,
"siteConfig": {
"numberOfWorkers": 1,
"defaultDocuments": [
"Default.htm",
"Default.html",
"Default.asp",
"index.htm",
"index.html",
"iisstart.htm",
"default.aspx",
"index.php",
"hostingstart.html"
],
"netFrameworkVersion": "v4.0",
"phpVersion": "5.6",
"pythonVersion": "",
"nodeVersion": "",
"powerShellVersion": "",
"linuxFxVersion": "",
"requestTracingEnabled": false,
"remoteDebuggingEnabled": false,
"httpLoggingEnabled": false,
"acrUseManagedIdentityCreds": false,
"logsDirectorySizeLimit": 35,
"detailedErrorLoggingEnabled": false,
"use32BitWorkerProcess": true,
"webSocketsEnabled": false,
"alwaysOn": false,
"appCommandLine": "",
"managedPipelineMode": "Integrated",
"virtualApplications": [
{
"virtualPath": "/",
"physicalPath": "site\\wwwroot",
"preloadEnabled": false
}
],
"loadBalancing": "LeastRequests",
"autoHealEnabled": false,
"vnetName": "",
"vnetRouteAllEnabled": false,
"vnetPrivatePortsCount": 0,
"http20Enabled": false,
"minTlsVersion": "1.2",
"scmMinTlsVersion": "1.2",
"ftpsState": "AllAllowed",
"functionAppScaleLimit": 0,
"functionsRuntimeScaleMonitoringEnabled": false,
"minimumElasticInstanceCount": 0,
"azureStorageAccounts": {}
},
"scmSiteAlsoStopped": false,
"clientAffinityEnabled": true,
"clientCertEnabled": false,
"clientCertMode": "Required",
"hostNamesDisabled": false,
"customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153",
"outboundIpAddresses": "70.37.102.201,20.225.43.144",
"possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188",
"containerSize": 0,
"dailyMemoryTimeQuota": 0,
"resourceGroup": "testrg123",
"defaultHostName": "sitef7252.azurewebsites.net",
"httpsOnly": false,
"redundancyMode": "None",
"storageAccountRequired": false,
"keyVaultReferenceIdentity": "SystemAssigned",
"workloadProfileName": "myd4wp",
"resourceConfig": {
"cpu": 1,
"memory": "2.0Gi"
}
}
}
]
}
Definitions
Name | Description |
---|---|
Api |
Information about the formal API definition for the app. |
Api |
Azure API management (APIM) configuration linked to the app. |
Authentication |
Authentication method to access the storage account for deployment. |
Authentication |
Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. |
Auto |
Actions which to take by the auto-heal module when a rule is triggered. |
Auto |
Predefined action to be taken. |
Auto |
Custom action to be executed when an auto heal rule is triggered. |
Auto |
Rules that can be defined for auto-heal. |
Auto |
Triggers for auto-heal. |
Azure |
Azure Files or Blob Storage access information value for dictionary storage. |
Azure |
Mounting protocol to use for the storage account. |
Azure |
State of the storage account. |
Azure |
Type of storage. |
Client |
This composes with ClientCertEnabled setting.
|
Cloning |
Information needed for cloning operation. |
Connection |
Type of database. |
Conn |
Database connection string information. |
Cors |
Cross-Origin Resource Sharing (CORS) settings for the app. |
Dapr |
App Dapr configuration. |
dapr |
Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. |
Default |
Default action for main access restriction if no rules are matched. |
Default |
App Service error response. |
Details | |
Error |
Error model. |
Experiments |
Routing rules in production experiments. |
Extended |
Extended Location. |
Ftps |
State of FTP / FTPS service |
Function |
Function app configuration. |
Functions |
Sets the number of 'Always Ready' instances for a function group or a specific function. |
Functions |
Configuration section for the function app deployment. |
Functions |
Property to select Azure Storage type. Available options: blobContainer. |
Functions |
Function app runtime name and version. |
Functions |
Scale and concurrency settings for the function app. |
Handler |
The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension. |
Hosting |
Specification for an App Service Environment to use for this resource. |
Host |
SSL-enabled hostname. |
Host |
Indicates whether the hostname is a standard or repository hostname. |
Http |
Scale and concurrency settings for the HTTP trigger. |
Ip |
Defines what this IP filter will be used for. This is to support IP filtering on proxies. |
Ip |
IP security restriction on an app. |
Managed |
Managed pipeline mode. |
Managed |
Managed service identity. |
Managed |
Type of managed service identity. |
Name |
Name value pair. |
Push |
Push settings for the App. |
Ramp |
Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. |
Redundancy |
Site redundancy mode |
Requests |
Trigger based on total requests. |
Resource |
Function app resource requirements. |
Runtime |
Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom |
Scm |
SCM type. |
Site |
A web app, a mobile app backend, or an API app. |
Site |
Management information availability state for the app. |
Site |
Configuration of an App Service app. |
Site |
|
Site |
Metric limits set on an app. |
Site |
Site load balancing. |
Site |
MachineKey of an app. |
Slot |
The status of the last successful slot swap operation. |
Slow |
Trigger based on request execution time. |
Ssl |
SSL type |
Status |
Trigger based on status code. |
Status |
Trigger based on range of status codes. |
Storage |
Storage for deployed package used by the function app. |
Supported |
MinTlsVersion: configures the minimum version of TLS required for SSL requests |
Tls |
The minimum strength TLS cipher suite allowed for an application |
Triggers |
Scale and concurrency settings for the function app triggers. |
Usage |
State indicating whether the app has exceeded its quota usage. Read-only. |
user |
User Assigned identity. |
Virtual |
Virtual application in an app. |
Virtual |
Directory for virtual application. |
Web |
Collection of App Service apps. |
ApiDefinitionInfo
Information about the formal API definition for the app.
Name | Type | Description |
---|---|---|
url |
string |
The URL of the API definition. |
ApiManagementConfig
Azure API management (APIM) configuration linked to the app.
Name | Type | Description |
---|---|---|
id |
string |
APIM-Api Identifier. |
Authentication
Authentication method to access the storage account for deployment.
Name | Type | Description |
---|---|---|
storageAccountConnectionStringName |
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. |
type |
Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. |
|
userAssignedIdentityResourceId |
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. |
AuthenticationType
Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString.
Name | Type | Description |
---|---|---|
StorageAccountConnectionString |
string |
|
SystemAssignedIdentity |
string |
|
UserAssignedIdentity |
string |
AutoHealActions
Actions which to take by the auto-heal module when a rule is triggered.
Name | Type | Description |
---|---|---|
actionType |
Predefined action to be taken. |
|
customAction |
Custom action to be taken. |
|
minProcessExecutionTime |
string |
Minimum time the process must execute before taking the action |
AutoHealActionType
Predefined action to be taken.
Name | Type | Description |
---|---|---|
CustomAction |
string |
|
LogEvent |
string |
|
Recycle |
string |
AutoHealCustomAction
Custom action to be executed when an auto heal rule is triggered.
Name | Type | Description |
---|---|---|
exe |
string |
Executable to be run. |
parameters |
string |
Parameters for the executable. |
AutoHealRules
Rules that can be defined for auto-heal.
Name | Type | Description |
---|---|---|
actions |
Actions to be executed when a rule is triggered. |
|
triggers |
Conditions that describe when to execute the auto-heal actions. |
AutoHealTriggers
Triggers for auto-heal.
Name | Type | Description |
---|---|---|
privateBytesInKB |
integer |
A rule based on private bytes. |
requests |
A rule based on total requests. |
|
slowRequests |
A rule based on request execution time. |
|
slowRequestsWithPath |
A rule based on multiple Slow Requests Rule with path |
|
statusCodes |
A rule based on status codes. |
|
statusCodesRange |
A rule based on status codes ranges. |
AzureStorageInfoValue
Azure Files or Blob Storage access information value for dictionary storage.
Name | Type | Description |
---|---|---|
accessKey |
string |
Access key for the storage account. |
accountName |
string |
Name of the storage account. |
mountPath |
string |
Path to mount the storage within the site's runtime environment. |
protocol |
Mounting protocol to use for the storage account. |
|
shareName |
string |
Name of the file share (container name, for Blob storage). |
state |
State of the storage account. |
|
type |
Type of storage. |
AzureStorageProtocol
Mounting protocol to use for the storage account.
Name | Type | Description |
---|---|---|
Http |
string |
|
Nfs |
string |
|
Smb |
string |
AzureStorageState
State of the storage account.
Name | Type | Description |
---|---|---|
InvalidCredentials |
string |
|
InvalidShare |
string |
|
NotValidated |
string |
|
Ok |
string |
AzureStorageType
Type of storage.
Name | Type | Description |
---|---|---|
AzureBlob |
string |
|
AzureFiles |
string |
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.
Name | Type | Description |
---|---|---|
Optional |
string |
|
OptionalInteractiveUser |
string |
|
Required |
string |
CloningInfo
Information needed for cloning operation.
Name | Type | Description |
---|---|---|
appSettingsOverrides |
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. |
cloneCustomHostNames |
boolean |
|
cloneSourceControl |
boolean |
|
configureLoadBalancing |
boolean |
|
correlationId |
string |
Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. |
hostingEnvironment |
string |
App Service Environment. |
overwrite |
boolean |
|
sourceWebAppId |
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. |
sourceWebAppLocation |
string |
Location of source app ex: West US or North Europe |
trafficManagerProfileId |
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}. |
trafficManagerProfileName |
string |
Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. |
ConnectionStringType
Type of database.
Name | Type | Description |
---|---|---|
ApiHub |
string |
|
Custom |
string |
|
DocDb |
string |
|
EventHub |
string |
|
MySql |
string |
|
NotificationHub |
string |
|
PostgreSQL |
string |
|
RedisCache |
string |
|
SQLAzure |
string |
|
SQLServer |
string |
|
ServiceBus |
string |
ConnStringInfo
Database connection string information.
Name | Type | Description |
---|---|---|
connectionString |
string |
Connection string value. |
name |
string |
Name of connection string. |
type |
Type of database. |
CorsSettings
Cross-Origin Resource Sharing (CORS) settings for the app.
Name | Type | Description |
---|---|---|
allowedOrigins |
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. |
supportCredentials |
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. |
DaprConfig
App Dapr configuration.
Name | Type | Default value | Description |
---|---|---|---|
appId |
string |
Dapr application identifier |
|
appPort |
integer |
Tells Dapr which port your application is listening on |
|
enableApiLogging |
boolean |
Enables API logging for the Dapr sidecar |
|
enabled |
boolean |
False |
Boolean indicating if the Dapr side car is enabled |
httpMaxRequestSize |
integer |
Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. |
|
httpReadBufferSize |
integer |
Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. |
|
logLevel |
Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. |
daprLogLevel
Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.
Name | Type | Description |
---|---|---|
debug |
string |
|
error |
string |
|
info |
string |
|
warn |
string |
DefaultAction
Default action for main access restriction if no rules are matched.
Name | Type | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
DefaultErrorResponse
App Service error response.
Name | Type | Description |
---|---|---|
error |
Error model. |
Details
Name | Type | Description |
---|---|---|
code |
string |
Standardized string to programmatically identify the error. |
message |
string |
Detailed error description and debugging information. |
target |
string |
Detailed error description and debugging information. |
Error
Error model.
Name | Type | Description |
---|---|---|
code |
string |
Standardized string to programmatically identify the error. |
details |
Details[] |
Detailed errors. |
innererror |
string |
More information to debug error. |
message |
string |
Detailed error description and debugging information. |
target |
string |
Detailed error description and debugging information. |
Experiments
Routing rules in production experiments.
Name | Type | Description |
---|---|---|
rampUpRules |
List of ramp-up rules. |
ExtendedLocation
Extended Location.
Name | Type | Description |
---|---|---|
name |
string |
Name of extended location. |
type |
string |
Type of extended location. |
FtpsState
State of FTP / FTPS service
Name | Type | Description |
---|---|---|
AllAllowed |
string |
|
Disabled |
string |
|
FtpsOnly |
string |
FunctionAppConfig
Function app configuration.
Name | Type | Description |
---|---|---|
deployment |
Function app deployment configuration. |
|
runtime |
Function app runtime settings. |
|
scaleAndConcurrency |
Function app scale and concurrency settings. |
FunctionsAlwaysReadyConfig
Sets the number of 'Always Ready' instances for a function group or a specific function.
Name | Type | Description |
---|---|---|
instanceCount |
integer |
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. |
name |
string |
Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. |
FunctionsDeployment
Configuration section for the function app deployment.
Name | Type | Description |
---|---|---|
storage |
Storage for deployed package used by the function app. |
FunctionsDeploymentStorageType
Property to select Azure Storage type. Available options: blobContainer.
Name | Type | Description |
---|---|---|
blobContainer |
string |
FunctionsRuntime
Function app runtime name and version.
Name | Type | Description |
---|---|---|
name |
Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom |
|
version |
string |
Function app runtime version. Example: 8 (for dotnet-isolated) |
FunctionsScaleAndConcurrency
Scale and concurrency settings for the function app.
Name | Type | Description |
---|---|---|
alwaysReady |
'Always Ready' configuration for the function app. |
|
instanceMemoryMB |
integer |
Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. |
maximumInstanceCount |
integer |
The maximum number of instances for the function app. |
triggers |
Scale and concurrency settings for the function app triggers. |
HandlerMapping
The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.
Name | Type | Description |
---|---|---|
arguments |
string |
Command-line arguments to be passed to the script processor. |
extension |
string |
Requests with this extension will be handled using the specified FastCGI application. |
scriptProcessor |
string |
The absolute path to the FastCGI application. |
HostingEnvironmentProfile
Specification for an App Service Environment to use for this resource.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID of the App Service Environment. |
name |
string |
Name of the App Service Environment. |
type |
string |
Resource type of the App Service Environment. |
HostNameSslState
SSL-enabled hostname.
Name | Type | Description |
---|---|---|
hostType |
Indicates whether the hostname is a standard or repository hostname. |
|
name |
string |
Hostname. |
sslState |
SSL type. |
|
thumbprint |
string |
SSL certificate thumbprint. |
toUpdate |
boolean |
Set to |
virtualIP |
string |
Virtual IP address assigned to the hostname if IP based SSL is enabled. |
HostType
Indicates whether the hostname is a standard or repository hostname.
Name | Type | Description |
---|---|---|
Repository |
string |
|
Standard |
string |
Http
Scale and concurrency settings for the HTTP trigger.
Name | Type | Description |
---|---|---|
perInstanceConcurrency |
integer |
The maximum number of concurrent HTTP trigger invocations per instance. |
IpFilterTag
Defines what this IP filter will be used for. This is to support IP filtering on proxies.
Name | Type | Description |
---|---|---|
Default |
string |
|
ServiceTag |
string |
|
XffProxy |
string |
IpSecurityRestriction
IP security restriction on an app.
Name | Type | Description |
---|---|---|
action |
string |
Allow or Deny access for this IP range. |
description |
string |
IP restriction rule description. |
headers |
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 ..
X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is ..
X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. |
ipAddress |
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. |
name |
string |
IP restriction rule name. |
priority |
integer |
Priority of IP restriction rule. |
subnetMask |
string |
Subnet mask for the range of IP addresses the restriction is valid for. |
subnetTrafficTag |
integer |
(internal) Subnet traffic tag |
tag |
Defines what this IP filter will be used for. This is to support IP filtering on proxies. |
|
vnetSubnetResourceId |
string |
Virtual network resource id |
vnetTrafficTag |
integer |
(internal) Vnet traffic tag |
ManagedPipelineMode
Managed pipeline mode.
Name | Type | Description |
---|---|---|
Classic |
string |
|
Integrated |
string |
ManagedServiceIdentity
Managed service identity.
Name | Type | Description |
---|---|---|
principalId |
string |
Principal Id of managed service identity. |
tenantId |
string |
Tenant of managed service identity. |
type |
Type of managed service identity. |
|
userAssignedIdentities |
<string,
user |
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} |
ManagedServiceIdentityType
Type of managed service identity.
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
NameValuePair
Name value pair.
Name | Type | Description |
---|---|---|
name |
string |
Pair name. |
value |
string |
Pair value. |
PushSettings
Push settings for the App.
Name | Type | Description |
---|---|---|
id |
string |
Resource Id. |
kind |
string |
Kind of resource. |
name |
string |
Resource Name. |
properties.dynamicTagsJson |
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. |
properties.isPushEnabled |
boolean |
Gets or sets a flag indicating whether the Push endpoint is enabled. |
properties.tagWhitelistJson |
string |
Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. |
properties.tagsRequiringAuth |
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. |
type |
string |
Resource type. |
RampUpRule
Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.
Name | Type | Description |
---|---|---|
actionHostName |
string |
Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. |
changeDecisionCallbackUrl |
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/ |
changeIntervalInMinutes |
integer |
Specifies interval in minutes to reevaluate ReroutePercentage. |
changeStep |
number |
In auto ramp up scenario this is the step to add/remove from |
maxReroutePercentage |
number |
Specifies upper boundary below which ReroutePercentage will stay. |
minReroutePercentage |
number |
Specifies lower boundary above which ReroutePercentage will stay. |
name |
string |
Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. |
reroutePercentage |
number |
Percentage of the traffic which will be redirected to |
RedundancyMode
Site redundancy mode
Name | Type | Description |
---|---|---|
ActiveActive |
string |
|
Failover |
string |
|
GeoRedundant |
string |
|
Manual |
string |
|
None |
string |
RequestsBasedTrigger
Trigger based on total requests.
Name | Type | Description |
---|---|---|
count |
integer |
Request Count. |
timeInterval |
string |
Time interval. |
ResourceConfig
Function app resource requirements.
Name | Type | Description |
---|---|---|
cpu |
number |
Required CPU in cores, e.g. 0.5 |
memory |
string |
Required memory, e.g. "1Gi" |
RuntimeName
Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom
Name | Type | Description |
---|---|---|
custom |
string |
|
dotnet-isolated |
string |
|
java |
string |
|
node |
string |
|
powershell |
string |
|
python |
string |
ScmType
SCM type.
Name | Type | Description |
---|---|---|
BitbucketGit |
string |
|
BitbucketHg |
string |
|
CodePlexGit |
string |
|
CodePlexHg |
string |
|
Dropbox |
string |
|
ExternalGit |
string |
|
ExternalHg |
string |
|
GitHub |
string |
|
LocalGit |
string |
|
None |
string |
|
OneDrive |
string |
|
Tfs |
string |
|
VSO |
string |
|
VSTSRM |
string |
Site
A web app, a mobile app backend, or an API app.
Name | Type | Default value | Description |
---|---|---|---|
extendedLocation |
Extended Location. |
||
id |
string |
Resource Id. |
|
identity |
Managed service identity. |
||
kind |
string |
Kind of resource. |
|
location |
string |
Resource Location. |
|
name |
string |
Resource Name. |
|
properties.availabilityState |
Management information availability state for the app. |
||
properties.clientAffinityEnabled |
boolean |
|
|
properties.clientCertEnabled |
boolean |
|
|
properties.clientCertExclusionPaths |
string |
client certificate authentication comma-separated exclusion paths |
|
properties.clientCertMode |
This composes with ClientCertEnabled setting.
|
||
properties.cloningInfo |
If specified during app creation, the app is cloned from a source app. |
||
properties.containerSize |
integer |
Size of the function container. |
|
properties.customDomainVerificationId |
string |
Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. |
|
properties.dailyMemoryTimeQuota |
integer |
Maximum allowed daily memory-time quota (applicable on dynamic apps only). |
|
properties.daprConfig |
Dapr configuration of the app. |
||
properties.defaultHostName |
string |
Default hostname of the app. Read-only. |
|
properties.dnsConfiguration |
Property to configure various DNS related settings for a site. |
||
properties.enabled |
boolean |
|
|
properties.enabledHostNames |
string[] |
Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. |
|
properties.endToEndEncryptionEnabled |
boolean |
Whether to use end to end encryption between the FrontEnd and the Worker |
|
properties.functionAppConfig |
Configuration specific of the Azure Function app. |
||
properties.hostNameSslStates |
Hostname SSL states are used to manage the SSL bindings for app's hostnames. |
||
properties.hostNames |
string[] |
Hostnames associated with the app. |
|
properties.hostNamesDisabled |
boolean |
|
|
properties.hostingEnvironmentProfile |
App Service Environment to use for the app. |
||
properties.httpsOnly |
boolean |
HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests |
|
properties.hyperV |
boolean |
False |
Hyper-V sandbox. |
properties.inProgressOperationId |
string |
Specifies an operation id if this site has a pending operation. |
|
properties.isDefaultContainer |
boolean |
|
|
properties.isXenon |
boolean |
False |
Obsolete: Hyper-V sandbox. |
properties.keyVaultReferenceIdentity |
string |
Identity to use for Key Vault Reference authentication. |
|
properties.lastModifiedTimeUtc |
string |
Last time the app was modified, in UTC. Read-only. |
|
properties.managedEnvironmentId |
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} |
|
properties.maxNumberOfWorkers |
integer |
Maximum number of workers. This only applies to Functions container. |
|
properties.outboundIpAddresses |
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. |
|
properties.possibleOutboundIpAddresses |
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. |
|
properties.publicNetworkAccess |
string |
Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. |
|
properties.redundancyMode |
Site redundancy mode |
||
properties.repositorySiteName |
string |
Name of the repository site. |
|
properties.reserved |
boolean |
False |
|
properties.resourceConfig |
Function app resource requirements. |
||
properties.resourceGroup |
string |
Name of the resource group the app belongs to. Read-only. |
|
properties.scmSiteAlsoStopped |
boolean |
False |
|
properties.serverFarmId |
string |
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". |
|
properties.siteConfig |
Configuration of the app. |
||
properties.slotSwapStatus |
Status of the last deployment slot swap operation. |
||
properties.state |
string |
Current state of the app. |
|
properties.storageAccountRequired |
boolean |
Checks if Customer provided storage account is required |
|
properties.suspendedTill |
string |
App suspended till in case memory-time quota is exceeded. |
|
properties.targetSwapSlot |
string |
Specifies which deployment slot this app will swap into. Read-only. |
|
properties.trafficManagerHostNames |
string[] |
Azure Traffic Manager hostnames associated with the app. Read-only. |
|
properties.usageState |
State indicating whether the app has exceeded its quota usage. Read-only. |
||
properties.virtualNetworkSubnetId |
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} |
|
properties.vnetBackupRestoreEnabled |
boolean |
To enable Backup and Restore operations over virtual network |
|
properties.vnetContentShareEnabled |
boolean |
To enable accessing content over virtual network |
|
properties.vnetImagePullEnabled |
boolean |
To enable pulling image over Virtual Network |
|
properties.vnetRouteAllEnabled |
boolean |
Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. |
|
properties.workloadProfileName |
string |
Workload profile name for function app to execute on. |
|
tags |
object |
Resource tags. |
|
type |
string |
Resource type. |
SiteAvailabilityState
Management information availability state for the app.
Name | Type | Description |
---|---|---|
DisasterRecoveryMode |
string |
|
Limited |
string |
|
Normal |
string |
SiteConfig
Configuration of an App Service app.
Name | Type | Default value | Description |
---|---|---|---|
acrUseManagedIdentityCreds |
boolean |
Flag to use Managed Identity Creds for ACR pull |
|
acrUserManagedIdentityID |
string |
If using user managed identity, the user managed identity ClientId |
|
alwaysOn |
boolean |
|
|
apiDefinition |
Information about the formal API definition for the app. |
||
apiManagementConfig |
Azure API management settings linked to the app. |
||
appCommandLine |
string |
App command line to launch. |
|
appSettings |
Application settings. |
||
autoHealEnabled |
boolean |
|
|
autoHealRules |
Auto Heal rules. |
||
autoSwapSlotName |
string |
Auto-swap slot name. |
|
azureStorageAccounts |
<string,
Azure |
List of Azure Storage Accounts. |
|
connectionStrings |
Connection strings. |
||
cors |
Cross-Origin Resource Sharing (CORS) settings. |
||
defaultDocuments |
string[] |
Default documents. |
|
detailedErrorLoggingEnabled |
boolean |
|
|
documentRoot |
string |
Document root. |
|
elasticWebAppScaleLimit |
integer |
Maximum number of workers that a site can scale out to.
This setting only applies to apps in plans where ElasticScaleEnabled is |
|
experiments |
This is work around for polymorphic types. |
||
ftpsState |
State of FTP / FTPS service |
||
functionAppScaleLimit |
integer |
Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans |
|
functionsRuntimeScaleMonitoringEnabled |
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. |
|
handlerMappings |
Handler mappings. |
||
healthCheckPath |
string |
Health check path |
|
http20Enabled |
boolean |
True |
Http20Enabled: configures a web site to allow clients to connect over http2.0 |
httpLoggingEnabled |
boolean |
|
|
ipSecurityRestrictions |
IP security restrictions for main. |
||
ipSecurityRestrictionsDefaultAction |
Default action for main access restriction if no rules are matched. |
||
javaContainer |
string |
Java container. |
|
javaContainerVersion |
string |
Java container version. |
|
javaVersion |
string |
Java version. |
|
keyVaultReferenceIdentity |
string |
Identity to use for Key Vault Reference authentication. |
|
limits |
Site limits. |
||
linuxFxVersion |
string |
Linux App Framework and version |
|
loadBalancing |
Site load balancing. |
||
localMySqlEnabled |
boolean |
False |
|
logsDirectorySizeLimit |
integer |
HTTP logs directory size limit. |
|
machineKey |
Site MachineKey. |
||
managedPipelineMode |
Managed pipeline mode. |
||
managedServiceIdentityId |
integer |
Managed Service Identity Id |
|
metadata |
Application metadata. This property cannot be retrieved, since it may contain secrets. |
||
minTlsCipherSuite |
The minimum strength TLS cipher suite allowed for an application |
||
minTlsVersion |
MinTlsVersion: configures the minimum version of TLS required for SSL requests |
||
minimumElasticInstanceCount |
integer |
Number of minimum instance count for a site This setting only applies to the Elastic Plans |
|
netFrameworkVersion |
string |
v4.6 |
.NET Framework version. |
nodeVersion |
string |
Version of Node.js. |
|
numberOfWorkers |
integer |
Number of workers. |
|
phpVersion |
string |
Version of PHP. |
|
powerShellVersion |
string |
Version of PowerShell. |
|
preWarmedInstanceCount |
integer |
Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans |
|
publicNetworkAccess |
string |
Property to allow or block all public traffic. |
|
publishingUsername |
string |
Publishing user name. |
|
push |
Push endpoint settings. |
||
pythonVersion |
string |
Version of Python. |
|
remoteDebuggingEnabled |
boolean |
|
|
remoteDebuggingVersion |
string |
Remote debugging version. |
|
requestTracingEnabled |
boolean |
|
|
requestTracingExpirationTime |
string |
Request tracing expiration time. |
|
scmIpSecurityRestrictions |
IP security restrictions for scm. |
||
scmIpSecurityRestrictionsDefaultAction |
Default action for scm access restriction if no rules are matched. |
||
scmIpSecurityRestrictionsUseMain |
boolean |
IP security restrictions for scm to use main. |
|
scmMinTlsVersion |
ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site |
||
scmType |
SCM type. |
||
tracingOptions |
string |
Tracing options. |
|
use32BitWorkerProcess |
boolean |
|
|
virtualApplications |
Virtual applications. |
||
vnetName |
string |
Virtual Network name. |
|
vnetPrivatePortsCount |
integer |
The number of private ports assigned to this app. These will be assigned dynamically on runtime. |
|
vnetRouteAllEnabled |
boolean |
Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. |
|
webSocketsEnabled |
boolean |
|
|
websiteTimeZone |
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 |
|
windowsFxVersion |
string |
Xenon App Framework and version |
|
xManagedServiceIdentityId |
integer |
Explicit Managed Service Identity Id |
SiteDnsConfig
Name | Type | Description |
---|---|---|
dnsAltServer |
string |
Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. |
dnsLegacySortOrder |
boolean |
Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. |
dnsMaxCacheTimeout |
integer |
Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. |
dnsRetryAttemptCount |
integer |
Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. |
dnsRetryAttemptTimeout |
integer |
Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. |
dnsServers |
string[] |
List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. |
SiteLimits
Metric limits set on an app.
Name | Type | Description |
---|---|---|
maxDiskSizeInMb |
integer |
Maximum allowed disk size usage in MB. |
maxMemoryInMb |
integer |
Maximum allowed memory usage in MB. |
maxPercentageCpu |
number |
Maximum allowed CPU usage percentage. |
SiteLoadBalancing
Site load balancing.
Name | Type | Description |
---|---|---|
LeastRequests |
string |
|
LeastResponseTime |
string |
|
PerSiteRoundRobin |
string |
|
RequestHash |
string |
|
WeightedRoundRobin |
string |
|
WeightedTotalTraffic |
string |
SiteMachineKey
MachineKey of an app.
Name | Type | Description |
---|---|---|
decryption |
string |
Algorithm used for decryption. |
decryptionKey |
string |
Decryption key. |
validation |
string |
MachineKey validation. |
validationKey |
string |
Validation key. |
SlotSwapStatus
The status of the last successful slot swap operation.
Name | Type | Description |
---|---|---|
destinationSlotName |
string |
The destination slot of the last swap operation. |
sourceSlotName |
string |
The source slot of the last swap operation. |
timestampUtc |
string |
The time the last successful slot swap completed. |
SlowRequestsBasedTrigger
Trigger based on request execution time.
Name | Type | Description |
---|---|---|
count |
integer |
Request Count. |
path |
string |
Request Path. |
timeInterval |
string |
Time interval. |
timeTaken |
string |
Time taken. |
SslState
SSL type
Name | Type | Description |
---|---|---|
Disabled |
string |
|
IpBasedEnabled |
string |
|
SniEnabled |
string |
StatusCodesBasedTrigger
Trigger based on status code.
Name | Type | Description |
---|---|---|
count |
integer |
Request Count. |
path |
string |
Request Path |
status |
integer |
HTTP status code. |
subStatus |
integer |
Request Sub Status. |
timeInterval |
string |
Time interval. |
win32Status |
integer |
Win32 error code. |
StatusCodesRangeBasedTrigger
Trigger based on range of status codes.
Name | Type | Description |
---|---|---|
count |
integer |
Request Count. |
path |
string |
|
statusCodes |
string |
HTTP status code. |
timeInterval |
string |
Time interval. |
Storage
Storage for deployed package used by the function app.
Name | Type | Description |
---|---|---|
authentication |
Authentication method to access the storage account for deployment. |
|
type |
Property to select Azure Storage type. Available options: blobContainer. |
|
value |
string |
Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. |
SupportedTlsVersions
MinTlsVersion: configures the minimum version of TLS required for SSL requests
Name | Type | Description |
---|---|---|
1.0 |
string |
|
1.1 |
string |
|
1.2 |
string |
|
1.3 |
string |
TlsCipherSuites
The minimum strength TLS cipher suite allowed for an application
Name | Type | Description |
---|---|---|
TLS_AES_128_GCM_SHA256 |
string |
|
TLS_AES_256_GCM_SHA384 |
string |
|
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 |
string |
|
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 |
string |
|
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 |
string |
|
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA |
string |
|
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 |
string |
|
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
string |
|
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA |
string |
|
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 |
string |
|
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 |
string |
|
TLS_RSA_WITH_AES_128_CBC_SHA |
string |
|
TLS_RSA_WITH_AES_128_CBC_SHA256 |
string |
|
TLS_RSA_WITH_AES_128_GCM_SHA256 |
string |
|
TLS_RSA_WITH_AES_256_CBC_SHA |
string |
|
TLS_RSA_WITH_AES_256_CBC_SHA256 |
string |
|
TLS_RSA_WITH_AES_256_GCM_SHA384 |
string |
Triggers
Scale and concurrency settings for the function app triggers.
Name | Type | Description |
---|---|---|
http |
Scale and concurrency settings for the HTTP trigger. |
UsageState
State indicating whether the app has exceeded its quota usage. Read-only.
Name | Type | Description |
---|---|---|
Exceeded |
string |
|
Normal |
string |
userAssignedIdentity
User Assigned identity.
Name | Type | Description |
---|---|---|
clientId |
string |
Client Id of user assigned identity |
principalId |
string |
Principal Id of user assigned identity |
VirtualApplication
Virtual application in an app.
Name | Type | Description |
---|---|---|
physicalPath |
string |
Physical path. |
preloadEnabled |
boolean |
|
virtualDirectories |
Virtual directories for virtual application. |
|
virtualPath |
string |
Virtual path. |
VirtualDirectory
Directory for virtual application.
Name | Type | Description |
---|---|---|
physicalPath |
string |
Physical path. |
virtualPath |
string |
Path to virtual application. |
WebAppCollection
Collection of App Service apps.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link to next page of resources. |
value |
Site[] |
Collection of resources. |