Web Apps - List

Get all apps for a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites?api-version=2016-08-01

URI Parameters

Name In Required Type Description
subscriptionId
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

Definitions

ApiDefinitionInfo

Information about the formal API definition for the app.

AutoHealActions

Actions which to take by the auto-heal module when a rule is triggered.

AutoHealActionType

Predefined action to be taken.

AutoHealCustomAction

Custom action to be executed when an auto heal rule is triggered.

AutoHealRules

Rules that can be defined for auto-heal.

AutoHealTriggers

Triggers for auto-heal.

CloningInfo

Information needed for cloning operation.

ConnectionStringType

Type of database.

ConnStringInfo

Database connection string information.

CorsSettings

Cross-Origin Resource Sharing (CORS) settings for the app.

Experiments

Routing rules in production experiments.

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.

HostingEnvironmentProfile

Specification for an App Service Environment to use for this resource.

HostNameSslState

SSL-enabled hostname.

HostType

Indicates whether the hostname is a standard or repository hostname.

IpSecurityRestriction

IP security restriction on an app.

ManagedPipelineMode

Managed pipeline mode.

ManagedServiceIdentity

Managed service identity.

ManagedServiceIdentityType

Type of managed service identity.

NameValuePair

Name value pair.

PushSettings

Push settings for the App.

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.

RequestsBasedTrigger

Trigger based on total requests.

ScmType

SCM type.

Site

A web app, a mobile app backend, or an API app.

SiteAvailabilityState

Management information availability state for the app.

SiteConfig

Configuration of an App Service app.

SiteLimits

Metric limits set on an app.

SiteLoadBalancing

Site load balancing.

SiteMachineKey

MachineKey of an app.

SlotSwapStatus

The status of the last successfull slot swap operation.

SlowRequestsBasedTrigger

Trigger based on request execution time.

SnapshotRecoveryRequest

Details about app recovery operation.

SnapshotRecoveryTarget

Specifies the web app that snapshot contents will be written to.

SslState

SSL type

StatusCodesBasedTrigger

Trigger based on status code.

SupportedTlsVersions

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

UsageState

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

VirtualApplication

Virtual application in an app.

VirtualDirectory

Directory for virtual application.

WebAppCollection

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.

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.

statusCodes

A rule based on status codes.

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

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

cloneSourceControl
  • boolean

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

configureLoadBalancing
  • boolean

true to configure load balancing for source and destination app.

correlationId
  • string

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

hostingEnvironment
  • string

App Service Environment.

ignoreQuotas
  • boolean

true if quotas should be ignored; otherwise, false.

overwrite
  • boolean

true to overwrite destination app; otherwise, false.

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.

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.

Experiments

Routing rules in production experiments.

Name Type Description
rampUpRules

List of ramp-up rules.

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 true to update existing hostname.

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

IpSecurityRestriction

IP security restriction on an app.

Name Type Description
ipAddress
  • string

IP address the security restriction is valid for.

subnetMask
  • string

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

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.

ManagedServiceIdentityType

Type of managed service identity.

Name Type Description
SystemAssigned
  • 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 mimuntes to reevaluate ReroutePercentage.

changeStep
  • number

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

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 ActionHostName.

RequestsBasedTrigger

Trigger based on total requests.

Name Type Description
count
  • integer

Request Count.

timeInterval
  • string

Time interval.

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

Site

A web app, a mobile app backend, or an API app.

Name Type Description
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

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.

properties.clientCertEnabled
  • boolean

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

properties.cloningInfo

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

properties.containerSize
  • integer

Size of the function container.

properties.dailyMemoryTimeQuota
  • integer

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

properties.defaultHostName
  • string

Default hostname of the app. Read-only.

properties.enabled
  • boolean

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

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

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

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.isDefaultContainer
  • boolean

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

properties.lastModifiedTimeUtc
  • string

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

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. Read-only.

properties.repositorySiteName
  • string

Name of the repository site.

properties.reserved
  • boolean

true if reserved; otherwise, false.

properties.resourceGroup
  • string

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

properties.scmSiteAlsoStopped
  • boolean

true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is 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.snapshotInfo

If specified during app creation, the app is created from a previous snapshot.

properties.state
  • string

Current state of the app.

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.

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 Description
alwaysOn
  • boolean

true if Always On is enabled; otherwise, false.

apiDefinition

Information about the formal API definition for the app.

appCommandLine
  • string

App command line to launch.

appSettings

Application settings.

autoHealEnabled
  • boolean

true if Auto Heal is enabled; otherwise, false.

autoHealRules

Auto Heal rules.

autoSwapSlotName
  • string

Auto-swap slot name.

connectionStrings

Connection strings.

cors

Cross-Origin Resource Sharing (CORS) settings.

defaultDocuments
  • string[]

Default documents.

detailedErrorLoggingEnabled
  • boolean

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

documentRoot
  • string

Document root.

experiments

This is work around for polymophic types.

handlerMappings

Handler mappings.

http20Enabled
  • boolean

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

httpLoggingEnabled
  • boolean

true if HTTP logging is enabled; otherwise, false.

ipSecurityRestrictions

IP security restrictions.

javaContainer
  • string

Java container.

javaContainerVersion
  • string

Java container version.

javaVersion
  • string

Java version.

limits

Site limits.

linuxFxVersion
  • string

Linux App Framework and version

loadBalancing

Site load balancing.

localMySqlEnabled
  • boolean

true to enable local MySQL; otherwise, false.

logsDirectorySizeLimit
  • integer

HTTP logs directory size limit.

machineKey

Site MachineKey.

managedPipelineMode

Managed pipeline mode.

minTlsVersion

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

netFrameworkVersion
  • string

.NET Framework version.

nodeVersion
  • string

Version of Node.js.

numberOfWorkers
  • integer

Number of workers.

phpVersion
  • string

Version of PHP.

publishingUsername
  • string

Publishing user name.

push

Push endpoint settings.

pythonVersion
  • string

Version of Python.

remoteDebuggingEnabled
  • boolean

true if remote debugging is enabled; otherwise, false.

remoteDebuggingVersion
  • string

Remote debugging version.

requestTracingEnabled
  • boolean

true if request tracing is enabled; otherwise, false.

requestTracingExpirationTime
  • string

Request tracing expiration time.

scmType

SCM type.

tracingOptions
  • string

Tracing options.

use32BitWorkerProcess
  • boolean

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

virtualApplications

Virtual applications.

vnetName
  • string

Virtual Network name.

webSocketsEnabled
  • boolean

true if WebSocket is enabled; otherwise, false.

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
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 successfull 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.

timeInterval
  • string

Time interval.

timeTaken
  • string

Time taken.

SnapshotRecoveryRequest

Details about app recovery operation.

Name Type Description
id
  • string

Resource Id.

kind
  • string

Kind of resource.

name
  • string

Resource Name.

properties.ignoreConflictingHostNames
  • boolean

If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled.

properties.overwrite
  • boolean

If true the recovery operation can overwrite source app; otherwise, false.

properties.recoverConfiguration
  • boolean

If true, site configuration, in addition to content, will be reverted.

properties.recoveryTarget

Specifies the web app that snapshot contents will be written to.

properties.snapshotTime
  • string

Point in time in which the app recovery should be attempted, formatted as a DateTime string.

type
  • string

Resource type.

SnapshotRecoveryTarget

Specifies the web app that snapshot contents will be written to.

Name Type Description
id
  • string

ARM resource ID of the target app. /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.

location
  • string

Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS

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.

status
  • integer

HTTP status code.

subStatus
  • integer

Request Sub Status.

timeInterval
  • string

Time interval.

win32Status
  • integer

Win32 error code.

SupportedTlsVersions

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

Name Type Description
1.0
  • string
1.1
  • string
1.2
  • string

UsageState

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

Name Type Description
Exceeded
  • string
Normal
  • string

VirtualApplication

Virtual application in an app.

Name Type Description
physicalPath
  • string

Physical path.

preloadEnabled
  • boolean

true if preloading is enabled; otherwise, false.

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

Collection of resources.