Microsoft.CertificateRegistration (stable:2015-08-01)

2025/02/27 • 25 updated methods

Global_GetAllSites (updated)
Description :  Gets all Web Apps for a subscription
Reference :  Link ¶

⚶ Changes

{
  "#id": "Global_GetAllSites",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "siteConfig": [
                  {
                    "properties": [
                      {
                        "experiments": [
                          {
                            "rampUpRules": {
                              "$properties": [
                                {
                                  "#name": "changeDecisionCallbackUrl",
                                  "Description": {
                                    "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                    "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/sites
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentSites (updated)
Description :  Get all sites on the hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚶ Changes

{
  "#id": "HostingEnvironments_GetHostingEnvironmentSites",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "siteConfig": [
                  {
                    "properties": [
                      {
                        "experiments": [
                          {
                            "rampUpRules": {
                              "$properties": [
                                {
                                  "#name": "changeDecisionCallbackUrl",
                                  "Description": {
                                    "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                    "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Comma separated list of site properties to include ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_SuspendHostingEnvironment (updated)
Description :  Suspends the hostingEnvironment.
Reference :  Link ¶

⚶ Changes

{
  "#id": "HostingEnvironments_SuspendHostingEnvironment",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "siteConfig": [
                  {
                    "properties": [
                      {
                        "experiments": [
                          {
                            "rampUpRules": {
                              "$properties": [
                                {
                                  "#name": "changeDecisionCallbackUrl",
                                  "Description": {
                                    "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                    "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "202": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "siteConfig": [
                  {
                    "properties": [
                      {
                        "experiments": [
                          {
                            "rampUpRules": {
                              "$properties": [
                                {
                                  "#name": "changeDecisionCallbackUrl",
                                  "Description": {
                                    "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                    "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_ResumeHostingEnvironment (updated)
Description :  Resumes the hostingEnvironment.
Reference :  Link ¶

⚶ Changes

{
  "#id": "HostingEnvironments_ResumeHostingEnvironment",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "siteConfig": [
                  {
                    "properties": [
                      {
                        "experiments": [
                          {
                            "rampUpRules": {
                              "$properties": [
                                {
                                  "#name": "changeDecisionCallbackUrl",
                                  "Description": {
                                    "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                    "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "202": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "siteConfig": [
                  {
                    "properties": [
                      {
                        "experiments": [
                          {
                            "rampUpRules": {
                              "$properties": [
                                {
                                  "#name": "changeDecisionCallbackUrl",
                                  "Description": {
                                    "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                    "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ManagedHostingEnvironments_GetManagedHostingEnvironmentSites (updated)
Description :  Get all sites on the managed hosting environment.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagedHostingEnvironments_GetManagedHostingEnvironmentSites",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "siteConfig": [
                  {
                    "properties": [
                      {
                        "experiments": [
                          {
                            "rampUpRules": {
                              "$properties": [
                                {
                                  "#name": "changeDecisionCallbackUrl",
                                  "Description": {
                                    "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                    "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/sites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Comma separated list of site properties to include ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ServerFarms_GetServerFarmSites (updated)
Description :  Gets list of Apps associated with an App Service Plan
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerFarms_GetServerFarmSites",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "siteConfig": [
                  {
                    "properties": [
                      {
                        "experiments": [
                          {
                            "rampUpRules": {
                              "$properties": [
                                {
                                  "#name": "changeDecisionCallbackUrl",
                                  "Description": {
                                    "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                    "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
$skipToken:
{
Description: Skip to of web apps in a list. If specified, the resulting list will contain web apps starting from (including) the skipToken. Else, the resulting list contains web apps from the start of the list ,
Required: False ,
}
string ,
$filter:
{
Description: Supported filter: $filter=state eq running. Returns only web apps that are currently running ,
Required: False ,
}
string ,
$top:
{
Description: List page size. If specified, results are paged. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteSlots (updated)
Description :  Gets all the slots for a web apps
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_GetSiteSlots",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "siteConfig": [
                  {
                    "properties": [
                      {
                        "experiments": [
                          {
                            "rampUpRules": {
                              "$properties": [
                                {
                                  "#name": "changeDecisionCallbackUrl",
                                  "Description": {
                                    "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                    "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: List of app properties to include in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSites (updated)
Description :  Gets the web apps for a subscription in the specified resource group
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_GetSites",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "siteConfig": [
                  {
                    "properties": [
                      {
                        "experiments": [
                          {
                            "rampUpRules": {
                              "$properties": [
                                {
                                  "#name": "changeDecisionCallbackUrl",
                                  "Description": {
                                    "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                    "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
includeSiteTypes:
{
Description: Types of apps included in the response ,
Required: False ,
}
string ,
includeSlots:
{
Description: Whether or not to include deployments slots in results ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSite (updated)
Description :  Get details of a web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_GetSite",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "siteConfig": [
              {
                "properties": [
                  {
                    "experiments": [
                      {
                        "rampUpRules": {
                          "$properties": [
                            {
                              "#name": "changeDecisionCallbackUrl",
                              "Description": {
                                "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_CreateOrUpdateSite (updated)
Description :  Creates a new web app or modifies an existing web app.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_CreateOrUpdateSite",
  "$parameters": {
    "siteEnvelope": {
      "$properties": {
        "properties": [
          {
            "siteConfig": [
              {
                "properties": [
                  {
                    "experiments": [
                      {
                        "rampUpRules": {
                          "$properties": [
                            {
                              "#name": "changeDecisionCallbackUrl",
                              "Description": {
                                "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "siteConfig": [
              {
                "properties": [
                  {
                    "experiments": [
                      {
                        "rampUpRules": {
                          "$properties": [
                            {
                              "#name": "changeDecisionCallbackUrl",
                              "Description": {
                                "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "siteConfig": [
              {
                "properties": [
                  {
                    "experiments": [
                      {
                        "rampUpRules": {
                          "$properties": [
                            {
                              "#name": "changeDecisionCallbackUrl",
                              "Description": {
                                "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the web app ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: Details of web app if it exists already ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
skipDnsRegistration:
{
Description: If true web app hostname is not registered with DNS on creation. This parameter is only used for app creation ,
Required: False ,
}
string ,
skipCustomDomainVerification:
{
Description: If true, custom (non *.azurewebsites.net) domains associated with web app are not verified. ,
Required: False ,
}
string ,
forceDnsRegistration:
{
Description: If true, web app hostname is force registered with DNS ,
Required: False ,
}
string ,
ttlInSeconds:
{
Description: Time to live in seconds for web app's default domain name ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteSlot (updated)
Description :  Get details of a web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_GetSiteSlot",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "siteConfig": [
              {
                "properties": [
                  {
                    "experiments": [
                      {
                        "rampUpRules": {
                          "$properties": [
                            {
                              "#name": "changeDecisionCallbackUrl",
                              "Description": {
                                "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_CreateOrUpdateSiteSlot (updated)
Description :  Creates a new web app or modifies an existing web app.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_CreateOrUpdateSiteSlot",
  "$parameters": {
    "siteEnvelope": {
      "$properties": {
        "properties": [
          {
            "siteConfig": [
              {
                "properties": [
                  {
                    "experiments": [
                      {
                        "rampUpRules": {
                          "$properties": [
                            {
                              "#name": "changeDecisionCallbackUrl",
                              "Description": {
                                "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "siteConfig": [
              {
                "properties": [
                  {
                    "experiments": [
                      {
                        "rampUpRules": {
                          "$properties": [
                            {
                              "#name": "changeDecisionCallbackUrl",
                              "Description": {
                                "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "siteConfig": [
              {
                "properties": [
                  {
                    "experiments": [
                      {
                        "rampUpRules": {
                          "$properties": [
                            {
                              "#name": "changeDecisionCallbackUrl",
                              "Description": {
                                "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the web app ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: Details of web app if it exists already ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
skipDnsRegistration:
{
Description: If true web app hostname is not registered with DNS on creation. This parameter is only used for app creation ,
Required: False ,
}
string ,
skipCustomDomainVerification:
{
Description: If true, custom (non *.azurewebsites.net) domains associated with web app are not verified. ,
Required: False ,
}
string ,
forceDnsRegistration:
{
Description: If true, web app hostname is force registered with DNS ,
Required: False ,
}
string ,
ttlInSeconds:
{
Description: Time to live in seconds for web app's default domain name ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_RecoverSite (updated)
Description :  Recovers a deleted web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_RecoverSite",
  "$responses": {
    "202": {
      "$properties": {
        "properties": [
          {
            "siteConfig": [
              {
                "properties": [
                  {
                    "experiments": [
                      {
                        "rampUpRules": {
                          "$properties": [
                            {
                              "#name": "changeDecisionCallbackUrl",
                              "Description": {
                                "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/recover
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
recoveryEntity:
{
Description: Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. ,
Required: True ,
}
{
snapshotTime:
{
Description: Point in time in which the site recover should be attempted. ,
Format: date-time ,
Required: False ,
}
string ,
recoverConfig:
{
Description: If true, then the website's configuration will be reverted to its state at SnapshotTime ,
Required: False ,
}
boolean ,
siteName:
{
Description: [Optional] Destination web app name into which web app should be recovered. This is case when new web app should be created instead. ,
Required: False ,
}
string ,
slotName:
{
Description: [Optional] Destination web app slot name into which web app should be recovered ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
Sites_RecoverSiteSlot (updated)
Description :  Recovers a deleted web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_RecoverSiteSlot",
  "$responses": {
    "202": {
      "$properties": {
        "properties": [
          {
            "siteConfig": [
              {
                "properties": [
                  {
                    "experiments": [
                      {
                        "rampUpRules": {
                          "$properties": [
                            {
                              "#name": "changeDecisionCallbackUrl",
                              "Description": {
                                "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/recover
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
recoveryEntity:
{
Description: Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. ,
Required: True ,
}
{
snapshotTime:
{
Description: Point in time in which the site recover should be attempted. ,
Format: date-time ,
Required: False ,
}
string ,
recoverConfig:
{
Description: If true, then the website's configuration will be reverted to its state at SnapshotTime ,
Required: False ,
}
boolean ,
siteName:
{
Description: [Optional] Destination web app name into which web app should be recovered. This is case when new web app should be created instead. ,
Required: False ,
}
string ,
slotName:
{
Description: [Optional] Destination web app slot name into which web app should be recovered ,
Required: False ,
}
string ,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
Sites_GetDeletedSites (updated)
Description :  Gets deleted web apps in subscription
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_GetDeletedSites",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "siteConfig": [
                  {
                    "properties": [
                      {
                        "experiments": [
                          {
                            "rampUpRules": {
                              "$properties": [
                                {
                                  "#name": "changeDecisionCallbackUrl",
                                  "Description": {
                                    "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                                    "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/deletedSites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
includeSiteTypes:
{
Description: Types of apps included in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
deletedTimestamp:
{
Description: Time when the site was deleted ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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 ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: 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} ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteConfig (updated)
Description :  Gets the configuration of the web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_GetSiteConfig",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "experiments": [
              {
                "rampUpRules": {
                  "$properties": [
                    {
                      "#name": "changeDecisionCallbackUrl",
                      "Description": {
                        "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                        "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_CreateOrUpdateSiteConfig (updated)
Description :  Update the configuration of web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_CreateOrUpdateSiteConfig",
  "$parameters": {
    "siteConfig": {
      "$properties": {
        "properties": [
          {
            "experiments": [
              {
                "rampUpRules": {
                  "$properties": [
                    {
                      "#name": "changeDecisionCallbackUrl",
                      "Description": {
                        "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                        "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "experiments": [
              {
                "rampUpRules": {
                  "$properties": [
                    {
                      "#name": "changeDecisionCallbackUrl",
                      "Description": {
                        "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                        "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_UpdateSiteConfig (updated)
Description :  Update the configuration of web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_UpdateSiteConfig",
  "$parameters": {
    "siteConfig": {
      "$properties": {
        "properties": [
          {
            "experiments": [
              {
                "rampUpRules": {
                  "$properties": [
                    {
                      "#name": "changeDecisionCallbackUrl",
                      "Description": {
                        "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                        "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "experiments": [
              {
                "rampUpRules": {
                  "$properties": [
                    {
                      "#name": "changeDecisionCallbackUrl",
                      "Description": {
                        "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                        "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_GetSiteConfigSlot (updated)
Description :  Gets the configuration of the web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_GetSiteConfigSlot",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "experiments": [
              {
                "rampUpRules": {
                  "$properties": [
                    {
                      "#name": "changeDecisionCallbackUrl",
                      "Description": {
                        "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                        "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_CreateOrUpdateSiteConfigSlot (updated)
Description :  Update the configuration of web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_CreateOrUpdateSiteConfigSlot",
  "$parameters": {
    "siteConfig": {
      "$properties": {
        "properties": [
          {
            "experiments": [
              {
                "rampUpRules": {
                  "$properties": [
                    {
                      "#name": "changeDecisionCallbackUrl",
                      "Description": {
                        "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                        "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "experiments": [
              {
                "rampUpRules": {
                  "$properties": [
                    {
                      "#name": "changeDecisionCallbackUrl",
                      "Description": {
                        "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                        "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_UpdateSiteConfigSlot (updated)
Description :  Update the configuration of web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_UpdateSiteConfigSlot",
  "$parameters": {
    "siteConfig": {
      "$properties": {
        "properties": [
          {
            "experiments": [
              {
                "rampUpRules": {
                  "$properties": [
                    {
                      "#name": "changeDecisionCallbackUrl",
                      "Description": {
                        "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                        "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "experiments": [
              {
                "rampUpRules": {
                  "$properties": [
                    {
                      "#name": "changeDecisionCallbackUrl",
                      "Description": {
                        "new": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified.",
                        "old": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n            https://www.siteextensions.net/packages/TiPCallback/"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: Net Framework Version ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
handlerMappings:
{
Description: Handler mappings ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App Command Line to launch ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications ,
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - custom action to be taken ,
Required: False ,
}
{
exe:
{
Description: Executable to be run ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_ListSiteAuthSettings (updated)
Description :  Gets the Authentication / Authorization settings associated with web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_ListSiteAuthSettings",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "issuer",
          "Description": {
            "new": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html",
            "old": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets the action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: Gets or sets the default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets the number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: Gets or sets the Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: Gets or sets the Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
issuer:
{
Description: Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets the OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: Gets or sets the client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: Gets or sets the App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: Gets or sets the App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: Gets or sets the OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: Gets or sets the OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: Gets or sets the OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: Gets or sets the OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
}
Sites_ListSiteAuthSettingsSlot (updated)
Description :  Gets the Authentication / Authorization settings associated with web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_ListSiteAuthSettingsSlot",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "issuer",
          "Description": {
            "new": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html",
            "old": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets the action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: Gets or sets the default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets the number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: Gets or sets the Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: Gets or sets the Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
issuer:
{
Description: Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets the OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: Gets or sets the client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: Gets or sets the App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: Gets or sets the App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: Gets or sets the OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: Gets or sets the OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: Gets or sets the OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: Gets or sets the OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
}
Sites_UpdateSiteAuthSettings (updated)
Description :  Updates the Authentication / Authorization settings associated with web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_UpdateSiteAuthSettings",
  "$parameters": {
    "siteAuthSettings": {
      "$properties": [
        {
          "#name": "issuer",
          "Description": {
            "new": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html",
            "old": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "issuer",
          "Description": {
            "new": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html",
            "old": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteAuthSettings:
{
Description: Auth settings associated with web app ,
Required: True ,
}
{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets the action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: Gets or sets the default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets the number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: Gets or sets the Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: Gets or sets the Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
issuer:
{
Description: Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets the OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: Gets or sets the client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: Gets or sets the App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: Gets or sets the App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: Gets or sets the OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: Gets or sets the OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: Gets or sets the OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: Gets or sets the OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets the action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: Gets or sets the default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets the number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: Gets or sets the Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: Gets or sets the Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
issuer:
{
Description: Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets the OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: Gets or sets the client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: Gets or sets the App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: Gets or sets the App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: Gets or sets the OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: Gets or sets the OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: Gets or sets the OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: Gets or sets the OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
}
Sites_UpdateSiteAuthSettingsSlot (updated)
Description :  Updates the Authentication / Authorization settings associated with web app
Reference :  Link ¶

⚶ Changes

{
  "#id": "Sites_UpdateSiteAuthSettingsSlot",
  "$parameters": {
    "siteAuthSettings": {
      "$properties": [
        {
          "#name": "issuer",
          "Description": {
            "new": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html",
            "old": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "issuer",
          "Description": {
            "new": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html",
            "old": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n            When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\r\n            This URI is a case-sensitive identifier for the token issuer.\r\n            More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteAuthSettings:
{
Description: Auth settings associated with web app ,
Required: True ,
}
{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets the action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: Gets or sets the default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets the number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: Gets or sets the Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: Gets or sets the Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
issuer:
{
Description: Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets the OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: Gets or sets the client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: Gets or sets the App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: Gets or sets the App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: Gets or sets the OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: Gets or sets the OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: Gets or sets the OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: Gets or sets the OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets the action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: Gets or sets the default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets the number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: Gets or sets the Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: Gets or sets the Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
issuer:
{
Description: Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets the OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: Gets or sets the client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: Gets or sets the App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: Gets or sets the App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: Gets or sets the OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: Gets or sets the OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: Gets or sets the OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: Gets or sets the OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets the OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
}