Web Apps - Get Configuration

Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web?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).

resourceGroupName
path True
  • string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

name
path True
  • string

Name of the app.

api-version
query True
  • string

API Version

Responses

Name Type Description
200 OK

OK

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

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.

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.

IpSecurityRestriction

IP security restriction on an app.

ManagedPipelineMode

Managed pipeline mode.

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.

SiteConfigResource

Web app configuration ARM resource.

SiteLimits

Metric limits set on an app.

SiteLoadBalancing

Site load balancing.

SiteMachineKey

MachineKey of an app.

SlowRequestsBasedTrigger

Trigger based on request execution time.

StatusCodesBasedTrigger

Trigger based on status code.

SupportedTlsVersions

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

VirtualApplication

Virtual application in an app.

VirtualDirectory

Directory for virtual application.

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.

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.

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

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 ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified 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

SiteConfigResource

Web app configuration ARM resource.

Name Type Description
id
  • string

Resource Id.

kind
  • string

Kind of resource.

name
  • string

Resource Name.

properties.alwaysOn
  • boolean

true if Always On is enabled; otherwise, false.

properties.apiDefinition

Information about the formal API definition for the app.

properties.appCommandLine
  • string

App command line to launch.

properties.appSettings

Application settings.

properties.autoHealEnabled
  • boolean

true if Auto Heal is enabled; otherwise, false.

properties.autoHealRules

Auto Heal rules.

properties.autoSwapSlotName
  • string

Auto-swap slot name.

properties.connectionStrings

Connection strings.

properties.cors

Cross-Origin Resource Sharing (CORS) settings.

properties.defaultDocuments
  • string[]

Default documents.

properties.detailedErrorLoggingEnabled
  • boolean

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

properties.documentRoot
  • string

Document root.

properties.experiments

This is work around for polymorphic types.

properties.handlerMappings

Handler mappings.

properties.http20Enabled
  • boolean

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

properties.httpLoggingEnabled
  • boolean

true if HTTP logging is enabled; otherwise, false.

properties.ipSecurityRestrictions

IP security restrictions.

properties.javaContainer
  • string

Java container.

properties.javaContainerVersion
  • string

Java container version.

properties.javaVersion
  • string

Java version.

properties.limits

Site limits.

properties.linuxFxVersion
  • string

Linux App Framework and version

properties.loadBalancing

Site load balancing.

properties.localMySqlEnabled
  • boolean

true to enable local MySQL; otherwise, false.

properties.logsDirectorySizeLimit
  • integer

HTTP logs directory size limit.

properties.machineKey

Site MachineKey.

properties.managedPipelineMode

Managed pipeline mode.

properties.minTlsVersion

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

properties.netFrameworkVersion
  • string

.NET Framework version.

properties.nodeVersion
  • string

Version of Node.js.

properties.numberOfWorkers
  • integer

Number of workers.

properties.phpVersion
  • string

Version of PHP.

properties.publishingUsername
  • string

Publishing user name.

properties.push

Push endpoint settings.

properties.pythonVersion
  • string

Version of Python.

properties.remoteDebuggingEnabled
  • boolean

true if remote debugging is enabled; otherwise, false.

properties.remoteDebuggingVersion
  • string

Remote debugging version.

properties.requestTracingEnabled
  • boolean

true if request tracing is enabled; otherwise, false.

properties.requestTracingExpirationTime
  • string

Request tracing expiration time.

properties.scmType

SCM type.

properties.tracingOptions
  • string

Tracing options.

properties.use32BitWorkerProcess
  • boolean

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

properties.virtualApplications

Virtual applications.

properties.vnetName
  • string

Virtual Network name.

properties.webSocketsEnabled
  • boolean

true if WebSocket is enabled; otherwise, false.

type
  • string

Resource type.

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.

SlowRequestsBasedTrigger

Trigger based on request execution time.

Name Type Description
count
  • integer

Request Count.

timeInterval
  • string

Time interval.

timeTaken
  • string

Time taken.

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

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.